quench-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a47a68f2482bbd2ff310e98d918b947114d4511fa81188d2bf33d70850208fb2
+  data.tar.gz: e74fb3a300f398ba436bc781093db2e92cba2ac907551d1fad1bab8bce8721d5
+SHA512:
+  metadata.gz: 208a981ca2c3fe80a868d1b3b12287d7887f1f80df4a4edb00d661602eb552ea0f57d7f4b1a93ada185b9057109e8634f440bab7d76a7541c961666f36f81d20
+  data.tar.gz: e9cbe724f9eef9a51f63d32befa9c060605b7b3d78a731474ab10d088a05ae40b290565eb64bc474999fee41892552ce38e64f580f7865abd3aeed590bb3c4b8

data/AUTHORS.md

@@ -0,0 +1,21 @@
+# Quench.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,20 @@
+# Quench.Ruby - Changes <!-- omit in toc -->
+
+
+## 0.0.1 - 19th August 2026
+
+* initial gold-standard packaging: **Gemfile**, **quench-ruby.gemspec**, **Rakefile**, GitHub Actions **ruby.yml**, **.sis**, **.editorconfig**, **.gitattributes**, **.gitignore**, helper scripts, and the Synesis markdown set;
+* stub library surface: `Quench` module and **VERSION** constants (`lib/quench.rb`, `lib/quench/version.rb`);
+* **quench-ruby.gemspec**: `spec.name` is `quench-ruby` (the name `quench` is taken on RubyGems); `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**;
+* **Gemfile** sets `lockfile false` when Bundler supports it; do not track **Gemfile.lock**;
+* CI uses `bundler-cache: false` and explicit `bundle install`; **Warnings** job on Ruby **3.4**; `gem build quench-ruby.gemspec`;
+* added **run_all_unit_tests.sh** (from https://github.com/synesissoftware/misc-dev-scripts) that skips **tput** when **$TERM** is unset or stdout is not a TTY;
+* **LICENSE** copyright holder filled in (Matthew Wilson and Synesis Information Systems, 2018–2026);
+
+
+## 0.0.0 - 3rd August 2018
+
+* initial commit;
+
+
+<!-- ########################### end of file ########################### -->

data/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Quench.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/Quench.Ruby/issues.
+
+
+## Pull requests
+
+Pull requests are welcome on https://github.com/synesissoftware/Quench.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,6 @@
+# Quench.Ruby - Examples <!-- omit in toc -->
+
+No example programs yet: the library currently ships as a stub (`Quench` + `VERSION` only). Examples will be added under [./examples/](./examples/) when the quenching API is implemented.
+
+
+<!-- ########################### end of file ########################### -->

data/FAQ.md

@@ -0,0 +1,27 @@
+# Quench.Ruby - FAQ <!-- omit in toc -->
+
+The FAQ list is under (constant) development. If you post a question on the
+[Issues](https://github.com/synesissoftware/Quench.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 quench-ruby
+```
+
+See [README.md](./README.md) for usage.
+
+
+<!-- ########################### end of file ########################### -->

data/INSTALL.md

@@ -0,0 +1,41 @@
+# Quench.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 quench-ruby
+```
+
+or add to a **Gemfile**:
+
+```Ruby
+gem 'quench-ruby'
+```
+
+then `bundle install`.
+
+
+## From a source checkout
+
+```
+bundle install
+bundle exec rake test
+```
+
+
+## Using the library
+
+```Ruby
+require 'quench'
+```
+
+
+<!-- ########################### end of file ########################### -->

data/LICENSE

@@ -0,0 +1,30 @@
+Quench.Ruby - BSD 3-Clause License
+
+Copyright (c) 2018-2026, Matthew Wilson and Synesis Information Systems
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+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.
+
+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.

data/NEWS.md

@@ -0,0 +1,9 @@
+# Quench.Ruby - News <!-- omit in toc -->
+
+| Date             | News Item                                                                                  |
+| ---------------- | ------------------------------------------------------------------------------------------ |
+| 19th August 2026 | [**Quench.Ruby** 0.0.1](https://github.com/synesissoftware/Quench.Ruby/releases/tag/0.0.1) |
+| 3rd August 2018  | **Quench.Ruby** 0.0.0 released                                                             |
+
+
+<!-- ########################### end of file ########################### -->

data/README.md

@@ -0,0 +1,127 @@
+# Quench.Ruby <!-- omit in toc -->
+
+Customisable exception-quenching library, for Ruby
+
+![Language](https://img.shields.io/badge/Ruby-CC342D?style=flat&logo=ruby&logoColor=white)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Gem Version](https://badge.fury.io/rb/quench-ruby.svg)](https://badge.fury.io/rb/quench-ruby)
+[![Last Commit](https://img.shields.io/github/last-commit/synesissoftware/Quench.Ruby)](https://github.com/synesissoftware/Quench.Ruby/commits/master)
+[![Ruby](https://github.com/synesissoftware/Quench.Ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/synesissoftware/Quench.Ruby/actions/workflows/ruby.yml)
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Examples](#examples)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Dependencies](#dependencies)
+    - [Efferent (fan-out)](#efferent-fan-out)
+      - [Runtime Dependencies (aka "Normal Dependencies")](#runtime-dependencies-aka-normal-dependencies)
+      - [Development Dependencies](#development-dependencies)
+    - [Afferent (fan-in)](#afferent-fan-in)
+      - [Runtime dependents](#runtime-dependents)
+      - [Development dependents](#development-dependents)
+  - [Related projects](#related-projects)
+  - [License](#license)
+
+
+## Introduction
+
+**Quench** provides customisable exception-quenching utilities. **Quench.Ruby** is the **Ruby** implementation.
+
+The library currently ships as a stub: the `Quench` module and version constants only. The quenching API is not yet implemented.
+
+
+## Installation
+
+Install via **gem** as in:
+
+```
+gem install quench-ruby
+```
+
+or add it to your `Gemfile`.
+
+**Quench.Ruby** requires Ruby **2.0+**.
+
+Use via **require**, as in:
+
+```Ruby
+require 'quench'
+```
+
+
+## Components
+
+* **`Quench`** — top-level namespace;
+* **`Quench::VERSION`** — library version string;
+* **`Quench::VERSION_MAJOR`**, **`Quench::VERSION_MINOR`**, **`Quench::VERSION_REVISION`** — version parts;
+
+
+## Examples
+
+The library currently ships as a stub, so there are no worked examples yet. See [EXAMPLES.md](./EXAMPLES.md).
+
+
+## Project Information
+
+
+### Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/Quench.Ruby "GitHub Page")
+
+
+### Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/Quench.Ruby.
+
+
+### Dependencies
+
+
+#### Efferent (fan-out)
+
+Libraries upon which **Quench.Ruby** depends:
+
+
+##### Runtime Dependencies (aka "Normal Dependencies")
+
+* \<none>;
+
+
+##### Development Dependencies
+
+* [**rake**](https://rubygems.org/gems/rake);
+* [**test-unit**](https://rubygems.org/gems/test-unit);
+
+
+#### Afferent (fan-in)
+
+Projects that depend on **Quench.Ruby**:
+
+
+##### Runtime dependents
+
+* \<none>;
+
+
+##### Development dependents
+
+* \<none>;
+
+
+### Related projects
+
+* \<none>;
+
+
+### License
+
+**Quench.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+
+
+<!-- ########################### end of file ########################### -->

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Rakefile for Quench.Ruby
+
+require 'rake/testtask'
+
+
+Rake::TestTask.new do |tt|
+
+  tt.libs << 'lib'
+  tt.libs << 'test'
+  tt.name = 'test'
+  tt.test_files = FileList['test/**/tc_*.rb']
+  tt.verbose = true
+end
+
+
+task :default => :test
+
+
+# ############################## end of file ############################# #

data/SECURITY.md

@@ -0,0 +1,22 @@
+# Quench.Ruby - Security <!-- omit in toc -->
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Reporting a vulnerability](#reporting-a-vulnerability)
+- [Supported versions](#supported-versions)
+
+
+## Reporting a vulnerability
+
+Please report security issues privately via GitHub Security Advisories on https://github.com/synesissoftware/Quench.Ruby/security, or by opening an issue if an advisory cannot be filed. Do not attach exploit proofs of concept against third-party systems.
+
+
+## Supported versions
+
+| Version | Supported |
+| ------- | --------- |
+| 0.0.x   | ✅        |
+
+
+<!-- ########################### end of file ########################### -->

data/TODO.md

@@ -0,0 +1,23 @@
+# Quench.Ruby - TODO <!-- omit in toc -->
+
+
+## Functional improvements
+
+* [ ] implement the exception-quenching API (currently stub: `Quench` + `VERSION` only);
+
+
+## Performance improvements
+
+* \<none
+
+
+## Packaging improvements
+
+* [x] ~~~updated **run_all_unit_tests.sh** (from **misc-dev-scripts**) to skip `tput` when `$TERM` is unset or stdout is not a TTY~~~;
+* [x] ~~~**Gemfile** `lockfile false`; do not track **Gemfile.lock**; CI `bundler-cache: false`~~~;
+* [x] ~~~gemspec polish: README tagline as `spec.summary`, package docs, exclude **Gemfile.lock** / **.ruby-version**; filename stem matches `spec.name` (`quench-ruby`)~~~;
+* [x] ~~~README canonical structure (tagline before badges; **Dependencies**; CI badge → **ruby.yml**)~~~;
+* [x] ~~~after the packaging/boilerplate/CI baseline: bump **VERSION** and align **CHANGES**/**NEWS**~~~;
+
+
+<!-- ########################### end of file ########################### -->

data/lib/quench/version.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# ######################################################################## #
+# File:     lib/quench/version.rb
+#
+# Purpose:  Version for Quench.Ruby library
+#
+# Created:  19th August 2026
+# Updated:  19th August 2026
+#
+# Home:     https://github.com/synesissoftware/Quench.Ruby
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 2018-2026, Matthew Wilson and Synesis Information Systems
+# 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.
+#
+# * 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 the copyright holders 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Quench
+
+  # Current version of the Quench.Ruby library
+  VERSION           = '0.0.1'
+
+  private
+  VERSION_PARTS_    = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+  public
+  # Major version of the Quench.Ruby library
+  VERSION_MAJOR     = VERSION_PARTS_[0] # :nodoc:
+  # Minor version of the Quench.Ruby library
+  VERSION_MINOR     = VERSION_PARTS_[1] # :nodoc:
+  # Revision version of the Quench.Ruby library
+  VERSION_REVISION  = VERSION_PARTS_[2] # :nodoc:
+end # module Quench
+
+
+# ############################## end of file ############################# #

data/lib/quench.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# ######################################################################## #
+# File:     quench.rb
+#
+# Purpose:  Top-level include for Quench.Ruby library
+#
+# Created:  19th August 2026
+# Updated:  19th August 2026
+#
+# Home:     https://github.com/synesissoftware/Quench.Ruby
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 2018-2026, Matthew Wilson and Synesis Information Systems
+# 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.
+#
+# * 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 the copyright holders 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Quench
+
+end # module Quench
+
+require 'quench/version'

data/test/unit/tc_version.rb

@@ -0,0 +1,37 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+
+require 'quench/version'
+
+require 'test/unit'
+
+
+class Test_version < Test::Unit::TestCase
+
+  def test_has_VERSION
+
+    assert defined? Quench::VERSION
+  end
+
+  def test_has_VERSION_MAJOR
+
+    assert defined? Quench::VERSION_MAJOR
+  end
+
+  def test_has_VERSION_MINOR
+
+    assert defined? Quench::VERSION_MINOR
+  end
+
+  def test_has_VERSION_REVISION
+
+    assert defined? Quench::VERSION_REVISION
+  end
+
+  def test_VERSION_has_consistent_format
+
+    assert_equal Quench::VERSION.split('.')[0..2].join('.'), "#{Quench::VERSION_MAJOR}.#{Quench::VERSION_MINOR}.#{Quench::VERSION_REVISION}"
+  end
+end

data/test/unit/ts_all.rb

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir    =   File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: quench-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-08-27 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Customisable exception-quenching library, for Ruby. Quench.Ruby currently
+  ships as a stub (module and version only); the quenching API is not yet
+  implemented.
+email:
+- matthew@synesis.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS.md
+- CHANGES.md
+- CONTRIBUTING.md
+- EXAMPLES.md
+- FAQ.md
+- INSTALL.md
+- LICENSE
+- NEWS.md
+- README.md
+- Rakefile
+- SECURITY.md
+- TODO.md
+- lib/quench.rb
+- lib/quench/version.rb
+- test/unit/tc_version.rb
+- test/unit/ts_all.rb
+homepage: https://github.com/synesissoftware/Quench.Ruby
+licenses:
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/synesissoftware/Quench.Ruby/issues
+  changelog_uri: https://github.com/synesissoftware/Quench.Ruby/blob/master/CHANGES.md
+  homepage_uri: https://github.com/synesissoftware/Quench.Ruby
+  source_code_uri: https://github.com/synesissoftware/Quench.Ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.3
+signing_key: 
+specification_version: 4
+summary: Customisable exception-quenching library, for Ruby
+test_files: []