Quench.Ruby

Customisable exception-quenching library, for 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

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:

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.

Project Information

Where to get help

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;
• 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 for details.