clasp-ruby 0.23.0.2 → 0.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6116d56077b53fd8d42a2f1275e08d5921982e2d4ffe425e9df637d6a7d97861
-  data.tar.gz: 778800e1fcacd3b7ccbb6911c3251c5fcca73fef3447c01318b458c36ef7472a
+  metadata.gz: 2a5885da7e4fe5d1cf3ffbc0f67977a27c9efbdddd26b0840aaeba75b3a46076
+  data.tar.gz: e67e35318c346513794314ac8d76c5f0020210c75d1811431fa2a8f5020c23ce
 SHA512:
-  metadata.gz: 56d7aa277b5f5441c9472d0bb1e8961ccd577ae6477e3ec82f5a932aa6033aa3bbd4506d290e664a4f74c1f2cf9915fb4bb7b41606f884a32e1f7a29dec0ab20
-  data.tar.gz: 33474797746dfe908b5d083d4aaedf4922d9b2cd990b0264595f557c1075d70ef0aa07d0940e1d3ed94869c0a70b999fdc3a3677f64145b2b2e6578afd904f13
+  metadata.gz: '0684c8effc10586d10a238d6fd640d46c7d888c3ae4c61ea37e1734eb9c000efa8445c50e9aee7b26fb59d98bfea7e51a5b2b105ba778fe5e03e898470114299'
+  data.tar.gz: 7ae5f53aca0352e97186f61f497dfeefed3036e14d170e60589ab78cb5c1ca1c3d18c27b3971e5b126dc8e645fa9ebf7f394ca3915eb8f72dcdc0023c341db19

data/AUTHORS.md

@@ -0,0 +1,21 @@
+# CLASP.Ruby - Authors <!-- omit in toc -->
+
+
+## Major Contributors
+
+| Name        | GitHub                            |
+| ----------- | --------------------------------- |
+| Matt Wilson | [mwsis](https://github.com/mwsis) |
+
+
+## Defect reports, fixes and suggestions (for which we are very grateful)
+
+| Name        | GitHub                            |
+| ----------- | --------------------------------- |
+| \<none>     |                                   |
+
+
+Contributions are welcomed.
+
+
+<!-- ########################### end of file ########################### -->

data/CHANGES.md

@@ -0,0 +1,313 @@
+# CLASP.Ruby - Changes <!-- omit in toc -->
+
+
+## 0.23.3 - 27th August 2026
+
+* renamed **CLASP.gemspec** to **clasp-ruby.gemspec** so the filename stem matches `spec.name`;
+* **clasp-ruby.gemspec**: `required_ruby_version` is the range `>= 1.9.3` (dropped `< 4`); **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**;
+* **Gemfile** sets `lockfile false` when Bundler supports it; stop tracking **Gemfile.lock**;
+* CI uses `bundler-cache: false` and explicit `bundle install`; **Warnings** job on Ruby **3.4**; `gem build clasp-ruby.gemspec`;
+* 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;
+* **README.md**: tagline before badges; dropped Downloads / GitHub-release badges; Dependencies (Efferent / Afferent);
+* **EXAMPLES.md** example links are repo-relative (`./examples/…`); catalogued remaining example programs;
+* library source **Home:** URLs now use `https`;
+
+
+## 0.23.2 - 15th August 2026
+
+* added `# frozen_string_literal: true` to all **lib/** sources;
+
+
+## 0.23.1 - 6th March 2025
+
+* warnings;
+* dependencies updated;
+* layout (to 2-space indents);
+
+
+## 0.23.0.2 - 20th January 2024
+
+* simplifying tests using heredocs;
+* minor documentation improvements;
+* canonicalised all whitespace (to SPACEs not TABs);
+
+
+## 0.23.0.1 - 1st December 2023
+
+* added attribute `CLASP::Arguments#double_slash_index`;
+* updated dependencies;
+
+
+## 0.22.1 - 26th June 2022
+
+* updated dependencies;
+
+
+## 0.22.0.1 - 22nd August 2020
+
+* merging branches, to clear up last two changes;
+* improved **CHANGES.md** markup (25th May 2020);
+
+
+## 0.22.0 - 29th April 2019
+
+* `#action` attribute for flag and option specifications (which is used in **libCLImate.Ruby**, and can be used by any application);
+
+
+## 0.21.0 - 28th April 2019
+
+* added typed values for options;
+
+
+## 0.20.3 - 19th April 2019
+
+* fix inconsistency in handling `default_value` behaviour;
+
+
+## 0.20.2 - 19th April 2019
+
+* restoring Ruby 1.9.3 compatibility;
+
+
+## 0.20.1.1 - 20th April 2019
+
+* documentation improvements;
+
+
+## 0.20.1 - 19th April 2019
+
+* fixed (ultimate) resolution of option argument specification;
+* fixed defect in `CLASP::Arguments::OptionArgument#==()`;
+
+
+## 0.20.0 - 19th April 2019
+
+* now uses `CLASP::OptionSpecification#default_value` (if non-nil) when option is specified without value (e.g. `"myprog --opt= -f1 -f2"`, `"myprog --opt"`);
+* `CLASP.show_usage()` now indicates default value in list of known values for option, and recognises the `:default_indicator` option for changing the indicator from default of `(default)`;
+
+
+## 0.19.1.1 - 19th April 2019
+
+* documentation improvements;
+* preparatory refactoring;
+
+
+## 0.19.1 - 19th April 2019
+
+* added missing `argument_specification` attribute to `CLASP::Arguments::FlagArgument` and `CLASP::Arguments::OptionArgument`, along with deprecated backwards-compatible `argument_alias`;
+
+
+## 0.19.0.1 - 19th April 2019
+
+* fixed some documentation typos;
+
+
+## 0.19.0 - 13th April 2019
+
+* added `CLASP::Arguments.load_specifications()`, which allows to load argument-specifications from `Hash` or from YAML;
+* `CLASP::Arguments.load()` now implemented in terms of `CLASP::Arguments.load_specifications()`;
+* `CLASP::FlagSpecification` and `CLASP::OptionSpecification` classes now compare against name (`String`) in `==()`;
+
+
+## 0.18.2 - 12th April 2019
+
+* documentation improvements;
+
+
+## 0.18.1 - 11th April 2019
+
+* completed [aA]lias(|es) => [sS]pecification(|s);
+
+
+## 0.18.0 - 10th April 2019
+
+* changed `*Alias` classes to `*Specification`;
+* `CLASP::Arguments#aliases` attribute is now changed to `#specifications`, and a [DEPRECATED] `#aliases` added;
+
+
+## 0.17.0 - 10th April 2019
+
+* added `CLASP::Arguments.load()`, which allows to load argument-specifications from `Hash` or from YAML;
+
+
+## 0.16.1 - 10th April 2019
+
+* minor adjustment to test case such that the library now compatible with Ruby 1.9.3+;
+
+
+## 0.16.0 - 19th March 2019
+
+* added #program_name attribute and #find_flag() and #find_option() methods to CLASP::Arguments class; + added examples;
+
+
+## 0.15.2 - 19th March 2019
+
+* fixed subtle defect (due to overloading of term 'options');
+
+
+## 0.15.1 - 19th March 2019
+
+* tagged release;
+
+
+## 0.15.0 - 27th February 2019
+
+* removed the ImmutableArray class, and associated unit-tests; ~ changed the 'flags', 'options', 'values' arrays to frozen Array instances;
+
+
+## 0.14.5 - 27th February 2019
+
+* fixed a freeze vulnerability;
+
+
+## 0.14.3 - 8th January 2019
+
+* fix;
+
+
+## 0.14.1.1 - 19th October 2018
+
+* dependencies;
+
+
+## 0.14.1 - 1st October 2018
+
+* 0.14;
+
+
+## 0.13.4 - 1st October 2018
+
+* minor mods;
+
+
+## 0.13.3 - 2nd March 2018
+
+* merge;
+
+
+## 0.13.2 - 1st March 2018
+
+* fixed defect in CLASP.show_usage() and CLASP.show_version() parameter checking, which failed to permit new CLASP::Alias type in aliases array;
+
+
+## 0.13.1 - 7th February 2018
+
+* fix;
+
+
+## 0.12.2 - 7th February 2018
+
+* tagged release;
+
+
+## 0.12.1 - 1st January 2018
+
+* added required_message;
+
+
+## 0.11.4 - 1st January 2018
+
+* more tests, prior to adding support for required? attribute;
+
+
+## 0.11.3 - 1st January 2018
+
+* minor improvements to documentation for Flag() & Option() creator methods;
+
+
+## 0.11.2 - 22nd June 2017
+
+* fixed debug-visible warnings;
+
+
+## 0.11.1 - 1st January 2018
+
+* tagged release;
+
+
+## 0.10.3 - 1st January 2018
+
+* tagged release;
+
+
+## 0.10.2 - 11th June 2016
+
+* added generate_rdoc.rb;
+
+
+## 0.10.1 - 10th June 2016
+
+* Clasp module alias now moved to separate file, therefore separate require;
+
+
+## 0.9.2 - 9th June 2016
+
+* added build_gem.sh;
+
+
+## 0.9.1 - 4th June 2016
+
+* merge;
+
+
+## 0.7.8 - 4th June 2016
+
+* changed syntax form of options to opt: from :opt =>;
+
+
+## 0.7.7 - 3rd June 2016
+
+* layout;
+
+
+## 0.7.5 - 5th February 2018
+
+* tagged release;
+
+
+## 0.7.4 - 5th February 2018
+
+* tagged release;
+
+
+## 0.7.3 - 5th February 2018
+
+* tagged release;
+
+
+## 0.7.2 - 5th February 2018
+
+* tagged release;
+
+
+## 0.7.1 - 5th February 2018
+
+* tagged release;
+
+
+## 0.6.10 - 5th February 2018
+
+* merge;
+
+
+## 0.6.9 - 5th February 2018
+
+* tagged release;
+
+
+## 0.6.8 - 5th February 2018
+
+* tagged release;
+
+
+## 0.6.7 - 5th February 2018
+
+* tagged release;
+
+
+## 0.6.5 - 5th February 2018
+
+* tagged release;
+
+
+<!-- ########################### end of file ########################### -->

data/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# CLASP.Ruby - Contributing <!-- omit in toc -->
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Defects and features](#defects-and-features)
+- [Pull requests](#pull-requests)
+- [Tests](#tests)
+- [License](#license)
+
+
+## Defects and features
+
+Open an issue on https://github.com/synesissoftware/CLASP.Ruby/issues.
+
+
+## Pull requests
+
+Pull requests are welcome on https://github.com/synesissoftware/CLASP.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**).
+
+
+## Tests
+
+```
+bundle exec rake test
+```
+
+or `./run_all_unit_tests.sh`.
+
+
+## License
+
+Contributions are accepted under the 3-clause BSD license. See [LICENSE](./LICENSE).
+
+
+<!-- ########################### end of file ########################### -->

data/EXAMPLES.md

@@ -0,0 +1,11 @@
+# CLASP.Ruby - Examples <!-- omit in toc -->
+
+|Name|Source & Description|Summary|
+|---|---|---|
+|**cr-example**|[examples/cr-example.rb](./examples/cr-example.rb)|Worked example of flags, options, values, aliases, **CLASP.show_usage()**, and **CLASP.show_version()**|
+|**flag_and_option_specifications**|[examples/flag_and_option_specifications.rb](./examples/flag_and_option_specifications.rb)<br/>[examples/flag_and_option_specifications.md](./examples/flag_and_option_specifications.md)|Example illustrating various kinds of *flag* and *option* specifications|
+|**show_usage_and_version**|[examples/show_usage_and_version.rb](./examples/show_usage_and_version.rb)<br/>[examples/show_usage_and_version.md](./examples/show_usage_and_version.md)|Simple example supporting ```--help``` and ```--version```|
+|**simple_command_line_no_specifications**|[examples/simple_command_line_no_specifications.rb](./examples/simple_command_line_no_specifications.rb)|Parses a command-line without flag/option specifications|
+
+
+<!-- ########################### end of file ########################### -->

data/FAQ.md

@@ -0,0 +1,28 @@
+# CLASP.Ruby - FAQ <!-- omit in toc -->
+
+The FAQ list is under (constant) development. If you post a question on the
+[Issues](https://github.com/synesissoftware/CLASP.Ruby/issues) forum
+it will be used to create one.
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Q1: "How do I install this library?"](#q1-how-do-i-install-this-library)
+
+
+# FAQs: <!-- omit in toc -->
+
+
+## Q1: "How do I install this library?"
+
+Install via **gem**:
+
+```
+gem install clasp-ruby
+```
+
+See [README.md](./README.md) for usage.
+
+
+
+<!-- ########################### end of file ########################### -->

data/INSTALL.md

@@ -0,0 +1,41 @@
+# CLASP.Ruby - Installation and Use <!-- omit in toc -->
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Install the gem](#install-the-gem)
+- [From a source checkout](#from-a-source-checkout)
+- [Using the library](#using-the-library)
+
+
+## Install the gem
+
+```
+gem install clasp-ruby
+```
+
+or add to a **Gemfile**:
+
+```Ruby
+gem 'clasp-ruby'
+```
+
+then `bundle install`.
+
+
+## From a source checkout
+
+```
+bundle install
+bundle exec rake test
+```
+
+
+## Using the library
+
+```Ruby
+require 'clasp'
+```
+
+
+<!-- ########################### end of file ########################### -->

data/LICENSE

@@ -1,31 +1,32 @@
-CLASP.Ruby
+CLASP.Ruby - BSD 3-Clause License
 
-Copyright (c) 2008-2016, Matthew Wilson and Synesis Software
+Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems
+Copyright (c) 2008-2019, Matthew Wilson and Synesis Software
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
 
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
 
-* Neither the names of CLASP or CLASP.Ruby nor the names of the copyright
-  holder nor the names of its contributors may be used to endorse or promote
-  products derived from this software without specific prior written
-  permission.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
 

data/NEWS.md

@@ -0,0 +1,65 @@
+# CLASP.Ruby - News <!-- omit in toc -->
+
+| Date               | News Item                                                                                  |
+| ------------------ | ------------------------------------------------------------------------------------------ |
+| 27th August 2026   | [**CLASP.Ruby** 0.23.3](https://github.com/synesissoftware/CLASP.Ruby/releases/tag/0.23.3) |
+| 15th August 2026   | [**CLASP.Ruby** 0.23.2](https://github.com/synesissoftware/CLASP.Ruby/releases/tag/0.23.2) |
+| 6th March 2025     | **CLASP.Ruby** 0.23.1 released                                                             |
+| 20th January 2024  | **CLASP.Ruby** 0.23.0.2 released                                                           |
+| 20th January 2024  | **CLASP.Ruby** 0.23.0.1 released                                                           |
+| 26th June 2022     | **CLASP.Ruby** 0.22.1 released                                                             |
+| 22nd August 2020   | **CLASP.Ruby** 0.22.0.1 released                                                           |
+| 29th April 2019    | **CLASP.Ruby** 0.22.0 released                                                             |
+| 28th April 2019    | **CLASP.Ruby** 0.21.0 released                                                             |
+| 20th April 2019    | **CLASP.Ruby** 0.20.3 released                                                             |
+| 20th April 2019    | **CLASP.Ruby** 0.20.2 released                                                             |
+| 20th April 2019    | **CLASP.Ruby** 0.20.1.1 released                                                           |
+| 19th April 2019    | **CLASP.Ruby** 0.20.1 released                                                             |
+| 19th April 2019    | **CLASP.Ruby** 0.20.0 released                                                             |
+| 19th April 2019    | **CLASP.Ruby** 0.19.1.1 released                                                           |
+| 19th April 2019    | **CLASP.Ruby** 0.19.1 released                                                             |
+| 19th April 2019    | **CLASP.Ruby** 0.19.0.1 released                                                           |
+| 13th April 2019    | **CLASP.Ruby** 0.19.0 released                                                             |
+| 12th April 2019    | **CLASP.Ruby** 0.18.2 released                                                             |
+| 11th April 2019    | **CLASP.Ruby** 0.18.1 released                                                             |
+| 10th April 2019    | **CLASP.Ruby** 0.18.0 released                                                             |
+| 10th April 2019    | **CLASP.Ruby** 0.17.0 released                                                             |
+| 10th April 2019    | **CLASP.Ruby** 0.16.1 released                                                             |
+| 19th March 2019    | **CLASP.Ruby** 0.16.0 released                                                             |
+| 19th March 2019    | **CLASP.Ruby** 0.15.2 released                                                             |
+| 19th March 2019    | **CLASP.Ruby** 0.15.1 released                                                             |
+| 27th February 2019 | **CLASP.Ruby** 0.15.0 released                                                             |
+| 27th February 2019 | **CLASP.Ruby** 0.14.5 released                                                             |
+| 8th January 2019   | **CLASP.Ruby** 0.14.3 released                                                             |
+| 19th October 2018  | **CLASP.Ruby** 0.14.1.1 released                                                           |
+| 1st October 2018   | **CLASP.Ruby** 0.14.1 released                                                             |
+| 1st October 2018   | **CLASP.Ruby** 0.13.4 released                                                             |
+| 2nd March 2018     | **CLASP.Ruby** 0.13.3 released                                                             |
+| 1st March 2018     | **CLASP.Ruby** 0.13.2 released                                                             |
+| 7th February 2018  | **CLASP.Ruby** 0.13.1 released                                                             |
+| 7th February 2018  | **CLASP.Ruby** 0.12.2 released                                                             |
+| 5th February 2018  | **CLASP.Ruby** 0.7.5 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.7.4 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.7.3 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.7.2 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.7.1 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.6.10 released                                                             |
+| 5th February 2018  | **CLASP.Ruby** 0.6.9 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.6.8 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.6.7 released                                                              |
+| 5th February 2018  | **CLASP.Ruby** 0.6.5 released                                                              |
+| 1st January 2018   | **CLASP.Ruby** 0.12.1 released                                                             |
+| 1st January 2018   | **CLASP.Ruby** 0.11.4 released                                                             |
+| 1st January 2018   | **CLASP.Ruby** 0.11.3 released                                                             |
+| 1st January 2018   | **CLASP.Ruby** 0.11.1 released                                                             |
+| 1st January 2018   | **CLASP.Ruby** 0.10.3 released                                                             |
+| 22nd June 2017     | **CLASP.Ruby** 0.11.2 released                                                             |
+| 11th June 2016     | **CLASP.Ruby** 0.10.2 released                                                             |
+| 10th June 2016     | **CLASP.Ruby** 0.10.1 released                                                             |
+| 9th June 2016      | **CLASP.Ruby** 0.9.2 released                                                              |
+| 4th June 2016      | **CLASP.Ruby** 0.9.1 released                                                              |
+| 4th June 2016      | **CLASP.Ruby** 0.7.8 released                                                              |
+| 3rd June 2016      | **CLASP.Ruby** 0.7.7 released                                                              |
+
+
+<!-- ########################### end of file ########################### -->