woad 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e10c6463ceb8b3ac8b2a97d7c7dbdd701bbd0ab3255a81d5dacfe3b3dff7df5d
+  data.tar.gz: b998571e72109901df0a54307acd283a1edb38d9e742669e89ac6ed77edb0772
+SHA512:
+  metadata.gz: 356f16c466b43294a074fe6120de19fdc1d91eb4cfdace8680206172b132ec406ebae66b655381881540b7751109269e7a3c58b65ff08282b4fa13c8235a5300
+  data.tar.gz: e50e17671d1ac7582bd661ee2eef762f0574b1bfd5cf565ee5df44cd8692e7e64f9301b2262e38975d0a0e96fd9af32aa68ab5c6a01fb0a2c8939ec00e7d5dfd

data/AUTHORS.md

@@ -0,0 +1,21 @@
+# woad.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,10 @@
+# woad.Ruby - Changes <!-- omit in toc -->
+
+
+## 0.0.0 - 15th August 2026
+
+* initial project scaffolding;
+* **Ruby** **2.0+** compatibility;
+
+
+<!-- ########################### end of file ########################### -->

data/LICENSE

@@ -0,0 +1,30 @@
+woad.Ruby - BSD 3-Clause License
+
+Copyright (c) 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/README.md

@@ -0,0 +1,91 @@
+# woad.Ruby <!-- omit in toc -->
+
+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)
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Dependencies](#dependencies)
+    - [Development Dependencies](#development-dependencies)
+  - [Related projects](#related-projects)
+  - [License](#license)
+
+
+## Introduction
+
+**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**.
+
+
+## Installation
+
+Install via **gem** as in:
+
+```
+gem install woad
+```
+
+or add it to your `Gemfile`.
+
+Use via **require**, as in:
+
+```Ruby
+require 'woad'
+```
+
+
+## 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.
+
+
+## Project Information
+
+
+### Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/woad.Ruby "GitHub Page")
+
+
+### Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/woad.Ruby.
+
+
+### Dependencies
+
+* \<none>
+
+
+#### Development Dependencies
+
+* [**rake**](https://github.com/ruby/rake)
+* [**test-unit**](https://github.com/test-unit/test-unit)
+
+
+### Related projects
+
+* [**woad.Python**](https://github.com/synesissoftware/woad.Python/)
+* [**woad.Rust**](https://github.com/synesissoftware/woad.Rust/)
+
+
+### License
+
+**woad.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 woad.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/TODO.md

@@ -0,0 +1,21 @@
+# woad.Ruby - TODO <!-- omit in toc -->
+
+
+## Functional improvements
+
+* [ ] SGR colour and reset codes;
+* [ ] TTY-conditional colour codes (process and per-stream);
+* [ ] Windows virtual-terminal gating (OS build + `GetConsoleMode`);
+
+
+## Performance improvements
+
+* \<none>
+
+
+## Packaging improvements
+
+* \<none>
+
+
+<!-- ########################### end of file ########################### -->

data/lib/woad/version.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# ######################################################################## #
+# File:     woad/version.rb
+#
+# Purpose:  Version for woad.Ruby library
+#
+# Created:  15th August 2026
+# Updated:  15th August 2026
+#
+# Home:     http://github.com/synesissoftware/woad.Ruby
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 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 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Woad
+
+  # Current version of the woad.Ruby library
+  VERSION           = '0.0.0'
+
+  private
+  # @!visibility private
+  VERSION_PARTS_    = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+  public
+  # Major version of the woad.Ruby library
+  VERSION_MAJOR     = VERSION_PARTS_[0] # :nodoc:
+  # Minor version of the woad.Ruby library
+  VERSION_MINOR     = VERSION_PARTS_[1] # :nodoc:
+  # Revision version of the woad.Ruby library
+  VERSION_REVISION  = VERSION_PARTS_[2] # :nodoc:
+end # module Woad
+
+
+# ############################## end of file ############################# #

data/lib/woad.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+# ######################################################################## #
+# File:     woad.rb
+#
+# Purpose:  Primary require for woad.Ruby library
+#
+# Created:  15th August 2026
+# Updated:  15th August 2026
+#
+# Home:     http://github.com/synesissoftware/woad.Ruby
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 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 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+## Root module for *woad*
+module Woad
+
+end # module Woad
+
+
+require 'woad/version'
+
+
+# ############################## end of file ############################# #

data/test/unit/tc_version.rb

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: woad
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-08-15 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Minimal ANSI terminal colour codes, for Ruby.
+
+  woad.Ruby is the Ruby implementation of the woad family of libraries.
+email:
+- matthew@synesis.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS.md
+- CHANGES.md
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- lib/woad.rb
+- lib/woad/version.rb
+- test/unit/tc_version.rb
+homepage: https://github.com/synesissoftware/woad.Ruby
+licenses:
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/synesissoftware/woad.Ruby/issues
+  changelog_uri: https://github.com/synesissoftware/woad.Ruby/blob/master/CHANGES.md
+  homepage_uri: https://github.com/synesissoftware/woad.Ruby
+  source_code_uri: https://github.com/synesissoftware/woad.Ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
+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: woad.Ruby
+test_files: []