woad 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10c6463ceb8b3ac8b2a97d7c7dbdd701bbd0ab3255a81d5dacfe3b3dff7df5d
-  data.tar.gz: b998571e72109901df0a54307acd283a1edb38d9e742669e89ac6ed77edb0772
+  metadata.gz: 13931221630333301aaa33438eccb58a62c6d1156961ac89af48ccf53a203871
+  data.tar.gz: fd74e7d8ffc6e32f58ee993f9763cd84fec7a98293c42af222771e0be202ddd9
 SHA512:
-  metadata.gz: 356f16c466b43294a074fe6120de19fdc1d91eb4cfdace8680206172b132ec406ebae66b655381881540b7751109269e7a3c58b65ff08282b4fa13c8235a5300
-  data.tar.gz: e50e17671d1ac7582bd661ee2eef762f0574b1bfd5cf565ee5df44cd8692e7e64f9301b2262e38975d0a0e96fd9af32aa68ab5c6a01fb0a2c8939ec00e7d5dfd
+  metadata.gz: 43731235a106d8ec4e905f90c3cfe1531348882499c8e2895e9e5c50b1074ae54bb3a9170438c6c6124b4cdb2565061231301b413b54adf316502ec238cf4757
+  data.tar.gz: 060fc1e463fa0e8307872ee8ec77dc6ebf53290cc3de07fa5d02016a377b75ab2ef01cd1029d464e891490dd5d3d386a4eca121ccc1f4da082fc986adc530f37

data/AUTHORS.md

@@ -10,9 +10,9 @@
 
 ## Defect reports, fixes and suggestions (for which we are very grateful)
 
-| Name    | GitHub |
-| ------- | ------ |
-| \<none> |        |
+| Name        | GitHub                            |
+| ----------- | --------------------------------- |
+| \<none>     |                                   |
 
 
 Contributions are welcomed.

data/CHANGES.md

@@ -1,6 +1,23 @@
 # woad.Ruby - Changes <!-- omit in toc -->
 
 
+## 0.0.2 - 19th August 2026
+
+* **EXAMPLES.md** catalog and **examples/print_status**;
+* reordered **README.md** (canonical sections; **Examples**; **Dependencies** Efferent / Afferent); dropped GitHub-release badge;
+* expanded **woad.gemspec** `spec.summary` to the README tagline; packaged **AUTHORS**, **CHANGES**, **CONTRIBUTING**, **EXAMPLES**, **FAQ**, **INSTALL**, **NEWS**, **SECURITY**, and **TODO**;
+* **woad.gemspec**: `required_ruby_version` is the range `>= 2.0` (dropped `< 5`); **Gemfile.lock** and **.ruby-version** excluded from `spec.files`;
+* **Gemfile** sets `lockfile false` when Bundler supports it; **.gitignore** includes **Gemfile.lock**; CI uses `bundler-cache: false` because Bundler 4 then writes no lockfile and **ruby/setup-ruby** cache cats **Gemfile.lock**;
+* CI **Warnings** job now runs on Ruby **3.4** via **run_all_unit_tests.sh** `--lib --warnings`;
+* 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;
+* library source **Home:** URL now uses `https`;
+
+
+## 0.0.1 - 15th August 2026
+
+* SGR colour and reset codes (`RESET`, `FG_*`, `BG_*`, including bright variants);
+
+
 ## 0.0.0 - 15th August 2026
 
 * initial project scaffolding;

data/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# woad.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/woad.Ruby/issues.
+
+
+## Pull requests
+
+Pull requests are welcome on https://github.com/synesissoftware/woad.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,8 @@
+# woad.Ruby - Examples <!-- omit in toc -->
+
+|Name|Source & Description|Summary|
+|---|---|---|
+|**print_status**|[examples/print_status.rb](./examples/print_status.rb)<br/>[examples/print_status.md](./examples/print_status.md)|Prints sample status words with **woad** SGR colour constants|
+
+
+<!-- ########################### end of file ########################### -->

data/FAQ.md

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

data/INSTALL.md

@@ -0,0 +1,43 @@
+# woad.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 woad
+```
+
+or add to a **Gemfile**:
+
+```Ruby
+gem 'woad'
+```
+
+then `bundle install`.
+
+
+## From a source checkout
+
+```
+bundle install
+bundle exec rake test
+```
+
+
+## Using the library
+
+```Ruby
+require 'woad'
+
+puts "#{Woad::FG_GREEN}ok#{Woad::RESET}"
+```
+
+
+<!-- ########################### end of file ########################### -->

data/NEWS.md

@@ -0,0 +1,10 @@
+# woad.Ruby - News <!-- omit in toc -->
+
+| Date             | News Item                                                                              |
+| ---------------- | -------------------------------------------------------------------------------------- |
+| 20th August 2026 | [**woad.Ruby** 0.0.2](https://github.com/synesissoftware/woad.Ruby/releases/tag/0.0.2) |
+| 15th August 2026 | [**woad.Ruby** 0.0.1](https://github.com/synesissoftware/woad.Ruby/releases/tag/0.0.1) |
+| 15th August 2026 | [**woad.Ruby** 0.0.0](https://github.com/synesissoftware/woad.Ruby/releases/tag/0.0.0) |
+
+
+<!-- ########################### end of file ########################### -->

data/README.md

@@ -5,7 +5,6 @@ Minimal ANSI terminal colour codes, 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/woad.svg)](https://badge.fury.io/rb/woad)
-[![GitHub release](https://img.shields.io/github/v/release/synesissoftware/woad.Ruby.svg)](https://github.com/synesissoftware/woad.Ruby/releases/latest)
 [![Last Commit](https://img.shields.io/github/last-commit/synesissoftware/woad.Ruby)](https://github.com/synesissoftware/woad.Ruby/commits/master)
 [![Ruby](https://github.com/synesissoftware/woad.Ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/synesissoftware/woad.Ruby/actions/workflows/ruby.yml)
 
@@ -15,11 +14,17 @@ Minimal ANSI terminal colour codes, for Ruby
 - [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)
-    - [Development Dependencies](#development-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)
 
@@ -28,7 +33,9 @@ Minimal ANSI terminal colour codes, for Ruby
 
 **woad** provides the smallest useful set of fixed ANSI SGR colour sequences for library authors. It is not a console or TUI framework.
 
-**woad.Ruby** is the **Ruby** implementation. It supports **Ruby 2.0** through **3.x**.
+**woad.Ruby** is the **Ruby** implementation. It supports **Ruby 2.0+**.
+
+It has **no dependencies** on any other non-standard library.
 
 
 ## Installation
@@ -45,12 +52,19 @@ Use via **require**, as in:
 
 ```Ruby
 require 'woad'
+
+puts "#{Woad::FG_GREEN}ok#{Woad::RESET}"
 ```
 
 
 ## Components
 
-**woad.Ruby** currently ships the **`Woad`** root module and version metadata (`require 'woad'`). Colour codes, TTY/stream gating, and Windows virtual-terminal opt-in are not implemented in this 0.0.0 skeleton.
+**woad.Ruby** ships SGR string constants (`RESET`, `FG_*`, `BG_*`, including bright variants). TTY/stream gating and Windows virtual-terminal opt-in are not implemented yet.
+
+
+## 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](./EXAMPLES.md).
 
 
 ## Project Information
@@ -68,19 +82,43 @@ Defect reports, feature requests, and pull requests are welcome on https://githu
 
 ### Dependencies
 
-* \<none>
+
+#### Efferent (fan-out)
+
+Libraries upon which **woad.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 **woad.Ruby**:
+
+
+##### Runtime dependents
+
+* \<none>;
 
 
-#### Development Dependencies
+##### Development dependents
 
-* [**rake**](https://github.com/ruby/rake)
-* [**test-unit**](https://github.com/test-unit/test-unit)
+* \<none>;
 
 
 ### Related projects
 
-* [**woad.Python**](https://github.com/synesissoftware/woad.Python/)
-* [**woad.Rust**](https://github.com/synesissoftware/woad.Rust/)
+* [**woad**](https://github.com/synesissoftware/woad/) (**C**);
+* [**woad.Python**](https://github.com/synesissoftware/woad.Python/);
+* [**woad.Rust**](https://github.com/synesissoftware/woad.Rust/);
 
 
 ### License

data/SECURITY.md

@@ -0,0 +1,22 @@
+# woad.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/woad.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

@@ -3,7 +3,7 @@
 
 ## Functional improvements
 
-* [ ] SGR colour and reset codes;
+* [x] ~~~SGR colour and reset codes~~~ ✅;
 * [ ] TTY-conditional colour codes (process and per-stream);
 * [ ] Windows virtual-terminal gating (OS build + `GetConsoleMode`);
 
@@ -15,7 +15,11 @@
 
 ## Packaging improvements
 
-* \<none>
+* [x] ~~~added **run_all_unit_tests.sh** (from **misc-dev-scripts**) that skips `tput` when `$TERM` is unset or stdout is not a TTY~~~;
+* [x] ~~~**Gemfile** `lockfile false`; gitignore **Gemfile.lock**; CI `bundler-cache: false`~~~;
+* [x] ~~~gemspec polish: README tagline as `spec.summary`, drop `< 5` upper bound, package docs, exclude **Gemfile.lock** / **.ruby-version**~~~;
+* [x] ~~~README canonical structure (tagline before badges; **Dependencies**; CI badge → **ruby.yml**); added **examples/print_status**~~~;
+* [x] ~~~after the packaging/boilerplate/CI baseline: bump **VERSION** and align **CHANGES**/**NEWS**~~~;
 
 
 <!-- ########################### end of file ########################### -->

data/examples/print_status.md

@@ -0,0 +1,35 @@
+# woad.Ruby - Example - **print_status**
+
+## Summary
+
+Prints sample status words using **woad** SGR foreground constants and **RESET**.
+
+## Source
+
+```ruby
+
+#! /usr/bin/env ruby
+
+# examples/print_status.rb
+
+require 'woad'
+
+puts "#{Woad::FG_GREEN}ok#{Woad::RESET}"
+puts "#{Woad::FG_YELLOW}warn#{Woad::RESET}"
+puts "#{Woad::FG_RED}error#{Woad::RESET}"
+```
+
+On a colour-capable terminal the words appear in green, yellow, and red, then the SGR state is reset.
+
+## Usage
+
+When run, this produces the following output (colours omitted here):
+
+```
+ok
+warn
+error
+```
+
+
+<!-- ########################### end of file ########################### -->

data/examples/print_status.rb

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+
+# examples/print_status.rb
+
+
+require 'woad'
+
+
+puts "#{Woad::FG_GREEN}ok#{Woad::RESET}"
+puts "#{Woad::FG_YELLOW}warn#{Woad::RESET}"
+puts "#{Woad::FG_RED}error#{Woad::RESET}"

data/lib/woad/version.rb

@@ -5,9 +5,9 @@
 # Purpose:  Version for woad.Ruby library
 #
 # Created:  15th August 2026
-# Updated:  15th August 2026
+# Updated:  20th August 2026
 #
-# Home:     http://github.com/synesissoftware/woad.Ruby
+# Home:     https://github.com/synesissoftware/woad.Ruby
 #
 # Author:   Matthew Wilson
 #
@@ -50,7 +50,7 @@
 module Woad
 
   # Current version of the woad.Ruby library
-  VERSION           = '0.0.0'
+  VERSION           = '0.0.2'
 
   private
   # @!visibility private

data/lib/woad.rb

@@ -5,9 +5,9 @@
 # Purpose:  Primary require for woad.Ruby library
 #
 # Created:  15th August 2026
-# Updated:  15th August 2026
+# Updated:  19th August 2026
 #
-# Home:     http://github.com/synesissoftware/woad.Ruby
+# Home:     https://github.com/synesissoftware/woad.Ruby
 #
 # Author:   Matthew Wilson
 #
@@ -50,6 +50,53 @@
 ## Root module for *woad*
 module Woad
 
+  # Reset
+
+  RESET                   = "\e[0m"
+
+  # Foreground (standard)
+
+  FG_BLACK                = "\e[30m"
+  FG_RED                  = "\e[31m"
+  FG_GREEN                = "\e[32m"
+  FG_YELLOW               = "\e[33m"
+  FG_BLUE                 = "\e[34m"
+  FG_MAGENTA              = "\e[35m"
+  FG_CYAN                 = "\e[36m"
+  FG_WHITE                = "\e[37m"
+
+  # Foreground (bright)
+
+  FG_BRIGHT_BLACK         = "\e[90m"
+  FG_BRIGHT_RED           = "\e[91m"
+  FG_BRIGHT_GREEN         = "\e[92m"
+  FG_BRIGHT_YELLOW        = "\e[93m"
+  FG_BRIGHT_BLUE          = "\e[94m"
+  FG_BRIGHT_MAGENTA       = "\e[95m"
+  FG_BRIGHT_CYAN          = "\e[96m"
+  FG_BRIGHT_WHITE         = "\e[97m"
+
+  # Background (standard)
+
+  BG_BLACK                = "\e[40m"
+  BG_RED                  = "\e[41m"
+  BG_GREEN                = "\e[42m"
+  BG_YELLOW               = "\e[43m"
+  BG_BLUE                 = "\e[44m"
+  BG_MAGENTA              = "\e[45m"
+  BG_CYAN                 = "\e[46m"
+  BG_WHITE                = "\e[47m"
+
+  # Background (bright)
+
+  BG_BRIGHT_BLACK         = "\e[100m"
+  BG_BRIGHT_RED           = "\e[101m"
+  BG_BRIGHT_GREEN         = "\e[102m"
+  BG_BRIGHT_YELLOW        = "\e[103m"
+  BG_BRIGHT_BLUE          = "\e[104m"
+  BG_BRIGHT_MAGENTA       = "\e[105m"
+  BG_BRIGHT_CYAN          = "\e[106m"
+  BG_BRIGHT_WHITE         = "\e[107m"
 end # module Woad
 
 

data/test/unit/tc_codes.rb

@@ -0,0 +1,42 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+
+require 'woad'
+
+require 'test/unit'
+
+
+class Test_codes < Test::Unit::TestCase
+
+  def test_RESET
+
+    assert_equal "\e[0m", Woad::RESET
+  end
+
+  def test_FG_RED
+
+    assert_equal "\e[31m", Woad::FG_RED
+  end
+
+  def test_BG_BLUE
+
+    assert_equal "\e[44m", Woad::BG_BLUE
+  end
+
+  def test_codes_are_csi_sgr
+
+    [
+      Woad::RESET,
+      Woad::FG_BLACK,
+      Woad::FG_BRIGHT_WHITE,
+      Woad::BG_BLACK,
+      Woad::BG_BRIGHT_WHITE,
+    ].each do |code|
+
+      assert code.start_with?("\e[")
+      assert code.end_with?('m')
+    end
+  end
+end

data/test/unit/ts_all.rb

@@ -0,0 +1,12 @@
+#! /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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woad
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-08-15 00:00:00.000000000 Z
+date: 2026-08-27 00:00:00.000000000 Z
 dependencies: []
 description: |
   Minimal ANSI terminal colour codes, for Ruby.
@@ -22,13 +22,23 @@ 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
+- examples/print_status.md
+- examples/print_status.rb
 - lib/woad.rb
 - lib/woad/version.rb
+- test/unit/tc_codes.rb
 - test/unit/tc_version.rb
+- test/unit/ts_all.rb
 homepage: https://github.com/synesissoftware/woad.Ruby
 licenses:
 - BSD-3-Clause
@@ -46,9 +56,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -59,5 +66,5 @@ rubyforge_project:
 rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
-summary: woad.Ruby
+summary: Minimal ANSI terminal colour codes, for Ruby
 test_files: []