windsock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17a5c3493485dca9b8a49c5f8e1b1515f6240e143d4fb338d7f52546ea5509af
+  data.tar.gz: 3b082d317bf4b09ca3385d574f390beaa46729defde92ab67501ca3922fa31c1
+SHA512:
+  metadata.gz: b3a6452c7e01ca3a2b2b4edad7be005a9e49742f7545775a171a3b33880ceb803fa496ade998cd94d99b81ef36e3a41e1a3a56d675e0c5f4c9639a702b6d4f14
+  data.tar.gz: fcf098d9aa027d0dddd130cc0f07bf21a83c3e44965e71509436ce818389ee6f0d9ad6899e7a35834e3a944dc7913f7faf8c440981164c8bb8af9f1651cd3513

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-10-14
+
+Initial release.
+
+- Parse Tailwind v4 `@theme` blocks with Tailwind's precedence rules; resolve `@import`
+  (including a bundled copy of Tailwind's default theme), `var()` and `--theme()`.
+- Convert oklch/oklab/hsl/rgb/hex/named colors to hex, `rgb()` and `rgba()`, with CSS
+  Color 4 gamut mapping.
+- `Theme` lookups: `#color`, `#colors`, `#scale`, `#scales`, `#scale_names`,
+  `#breakpoints`, `#fonts`, `#spacing` and the other namespaces; `#white`, `#black`
+  and `#text_color` use the theme's own `--color-white` / `--color-black`.
+- `color(:brand)` returns the brand `Scale` when the theme has `brand-*` steps but no
+  bare `--color-brand`.
+- `Windsock::Scale`: Hash-like steps that print as a WCAG contrast table in the console,
+  plus `contrast(on)`, `accessible(on:, level:)`, `text_colors` and `table(level:, color:)`.
+- WCAG helpers on `Color`: `#contrast`, `#accessible?`, `#aa?`, `#aaa?`,
+  `#contrast_level` (`:aaa`, `:aa`, `:aa_large` or `:fail`), `#text_color`, `#dark?`, `#name`;
+  `Color::WHITE` / `Color::BLACK`.
+- Rails: Railtie with dev reload, and `tailwind_color`, `tailwind_text_color`,
+  `tailwind_scale` and `tailwind_value` view helpers.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rave@beflagrant.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+Bug reports and pull requests are welcome at https://github.com/beflagrant/windsock.
+Everyone taking part is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+Include the Ruby and Windsock versions, the `@theme` CSS that misbehaves (trimmed
+to the smallest case you can), what you expected and what you got.
+
+## Making changes
+
+```
+bin/setup
+bundle exec rake        # tests + rubocop
+bin/console
+```
+
+- Add a test for the change. `bundle exec rake` must pass.
+- Add a line under `## [Unreleased]` in `CHANGELOG.md` for anything users would notice.
+- Keep pull requests to one change each.
+
+## Updating the bundled Tailwind theme
+
+Copy `theme.css` from the `tailwindcss` npm package into `lib/windsock/tailwind/`,
+update its `LICENSE` if it changed, and bump `Windsock::TAILWIND_VERSION`.
+
+## Security issues
+
+See [SECURITY.md](SECURITY.md). Don't open a public issue.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Flagrant, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+# Windsock
+
+Read your Tailwind v4 theme from Ruby.
+
+Tailwind v4 keeps your design tokens in CSS: `@theme { --color-brand-500: oklch(...) }`. That's the right place for them, but sometimes Ruby needs the same values. Windsock parses the stylesheet so you don't keep a second copy.
+
+```ruby
+Windsock.color(:brand, 500).to_hex   # => "#2b7fff"
+Windsock.scale(:brand)               # => every brand-* step, with WCAG contrast
+Windsock.scale_names                 # => ["red", "orange", ..., "brand"]
+Windsock.theme.breakpoints["md"]     # => "48rem"
+Windsock.theme.fonts["sans"]         # => "ui-sans-serif, system-ui, ..."
+```
+
+Where it helps:
+
+- **Mailers.** Email clients ignore CSS variables and don't understand `oklch()`. `tailwind_color(:brand, 500)` gives you a hex value to inline.
+- **PDFs, OG images, charts.** Prawn, Grover, Chartkick and friends want plain colors.
+- **Meta tags and manifests.** `theme-color`, PWA `manifest.json`.
+- **Tests.** Assert your brand palette is what you think it is.
+
+No Node, no Tailwind binary. It reads the CSS, resolves `@import` and `var()`, and converts colors.
+
+## Install
+
+```ruby
+gem "windsock"
+```
+
+## Rails
+
+Windsock reads `app/assets/tailwind/application.css` (the tailwindcss-rails default) and reloads when any `.css` in that directory changes in development.
+
+```ruby
+# config/application.rb (only if your stylesheet lives elsewhere)
+config.windsock.path = Rails.root.join("app/assets/stylesheets/main.css")
+```
+
+Views and mailers get helpers:
+
+```erb
+<a style="background: <%= tailwind_color(:brand, 500) %>; color: <%= tailwind_color(:white) %>">
+<meta name="theme-color" content="<%= tailwind_color(:brand, 900) %>">
+<%= tailwind_color(:brand, 500, format: :rgb) %>   <%# rgb(43 127 255) %>
+<%= tailwind_color(:brand, 500, format: :rgba) %>  <%# rgba(43, 127, 255, 1) — safest for email %>
+<%= tailwind_color(:brand, 500, format: :css) %>   <%# the value as written %>
+<%= tailwind_text_color(:brand, 500) %>            <%# the theme's black or white, whichever reads better on brand-500 %>
+<%= tailwind_value(:breakpoint, :md) %>            <%# 48rem %>
+```
+
+## Without Rails
+
+```ruby
+Windsock.path = "path/to/application.css"
+Windsock.theme
+
+# or
+theme = Windsock.load("path/to/application.css")
+theme = Windsock.parse(css_string, base_dir: "dir/for/relative/imports")
+```
+
+## Theme API
+
+```ruby
+theme = Windsock.theme
+
+theme[:color, :brand, 500]      # "oklch(62.3% 0.214 259.815)" — var() references resolved
+theme["color-brand-500"]        # same thing
+theme.raw(:color, :primary)     # "var(--color-brand-500)" — as written
+theme.fetch(:nope)              # raises Windsock::NotFound
+theme.key?(:color, :blue, 500)
+
+theme.color(:brand, 500)        # => Windsock::Color (or nil)
+theme.color!(:brand, 500)       # raises if missing
+theme.color(:brand)             # => the brand Scale when there is no --color-brand but there are brand-* steps
+theme.white, theme.black        # --color-white / --color-black, else pure #fff / #000
+theme.text_color(:brand, 500)   # theme.white or theme.black, whichever reads better on brand-500
+theme.colors                    # { "brand-500" => Color, "red-50" => Color, ... }
+theme.scale(:brand)             # Windsock::Scale: 50 => Color, ..., 950 => Color
+theme.scale_names               # ["red", "orange", ..., "brand"] — what #scale accepts
+theme.scales                    # { "brand" => Scale, "red" => Scale, ... }
+
+theme.breakpoints               # { "sm" => "40rem", "md" => "48rem", ... }
+theme.fonts, theme.radii, theme.shadows, theme.text_sizes, theme.containers,
+theme.tracking, theme.leading, theme.easings, theme.animations, theme.blurs
+theme.namespace(:anything)      # any --anything-* prefix
+
+theme.spacing                   # "0.25rem"
+theme.spacing(4)                # "1rem"
+theme.spacing(:gutter)          # a named --spacing-gutter
+
+theme.to_h                      # every variable, resolved
+Windsock.default_theme          # Tailwind's stock palette, untouched
+
+# Shortcuts on the module go to Windsock.theme:
+Windsock[...], Windsock.fetch, Windsock.color, Windsock.color!, Windsock.colors,
+Windsock.scale, Windsock.scales, Windsock.scale_names
+```
+
+## Scale API
+
+`scale(:brand)` returns a `Windsock::Scale`. It acts like a Hash of step => Color and prints as a table in the console, so you can see at a glance which steps work as text or background. In a terminal, ratios that meet AA (4.5:1) are green and the rest red; `scale.table(level: :aaa)` raises the bar, `scale.table(color: false)` turns the ANSI off.
+
+```
+>> Windsock.scale(:brand)
+#<Windsock::Scale brand (11 steps; contrast vs white #ffffff / black #000000; AA needs 4.5:1; text = what to write on it)
+  step  hex         white   black  text
+    50  #eff6ff      1.09   19.27  black
+   100  #dbeafe      1.22   17.22  black
+   ...
+   500  #2b7fff      3.76    5.58  black
+   600  #155dfc      5.26    4.00  white
+   ...
+   950  #162456     14.72    1.43  white
+>
+```
+
+```ruby
+scale = Windsock.scale(:brand)
+
+scale[500]                             # Color (also scale["500"], scale[:muted])
+scale.fetch(500)                       # raises Windsock::NotFound if missing
+scale.steps                            # [50, 100, ..., 950, "muted"]
+scale.each { |step, color| ... }       # Enumerable over [step, color]
+scale.to_h                             # plain Hash
+
+scale.contrast(:white)                 # { 50 => 1.09, ..., 950 => 14.72 } — WCAG ratios
+scale.accessible(on: :white)           # steps usable as text on white (AA, 4.5:1), as a Scale
+scale.accessible(on: "#000", level: :aaa)
+scale.text_colors                      # { 50 => black, ..., 950 => white } — text to put on each step
+scale.white, scale.black               # what "white" and "black" mean here
+```
+
+"White" and "black" are the theme's `--color-white` / `--color-black`. Tailwind ships them as `#fff` / `#000`, but an app that softens white to `#f5f5f5` gets its contrast measured against `#f5f5f5`, and the table title says so. `on:` also takes any theme color name (`scale.contrast(:surface)`) before falling back to CSS parsing.
+
+Levels are `:aa` (4.5:1), `:aa_large` (3:1, 18pt+ or 14pt bold), `:aaa` (7:1) and `:aaa_large` (4.5:1). Contrast ignores alpha: a translucent color is rated as if opaque.
+
+`color(:brand)` also returns the scale when the theme has `--color-brand-*` steps but no bare `--color-brand`. An exact `--color-brand` always wins. The view helpers want one color, so `tailwind_color(:brand)` raises `ArgumentError` naming the steps instead.
+
+## Color API
+
+```ruby
+c = Windsock.color(:brand, 500)
+c.to_hex            # "#2b7fff" ("#2b7fff80" when alpha < 1)
+c.to_hex(alpha: false)
+c.to_rgb            # "rgb(43 127 255)"
+c.to_rgba           # "rgba(43, 127, 255, 1)"
+c.rgb               # [43, 127, 255]
+c.alpha             # 1.0
+c.source            # "oklch(62.3% 0.214 259.815)"
+c.luminance         # WCAG relative luminance
+c.contrast("#fff")  # WCAG contrast ratio (any CSS color, a Color, or :white / :black)
+c.accessible?("#fff")                 # contrast >= 4.5 (AA for normal text)
+c.accessible?(:white, level: :aaa)    # :aa, :aa_large, :aaa, :aaa_large
+c.aa?("#fff") / c.aaa?("#fff", large: true)
+c.contrast_level("#fff")              # :aaa, :aa, :aa_large or :fail
+c.text_color        # Windsock::Color::BLACK or ::WHITE, whichever reads better on c
+c.text_color(white: theme.white, black: theme.black)   # same, with the theme's own
+c.dark?             # same question as a boolean
+
+Windsock::Color.parse("hsl(217 91% 60%)")  # any CSS color
+```
+
+Parses hex, named colors, `rgb()`, `hsl()`, `oklch()`, `oklab()`, `color(srgb ...)` and Tailwind's `--alpha(color / 50%)`.
+
+Colors outside the sRGB gamut (several of Tailwind's v4 defaults are) are gamut-mapped the way CSS Color 4 and browsers do it, so the hex values match what the Tailwind docs and DevTools show.
+
+## What it understands
+
+- `@theme`, `@theme inline`, `@theme static`, `@theme reference`, `@theme default`, with Tailwind's precedence rules
+- `@import "tailwindcss"` and `@import "tailwindcss/theme.css"` → bundled copy of Tailwind's default theme (currently v4.3.3, see `Windsock::TAILWIND_VERSION`)
+- Relative `@import "./partials/brand.css"` (missing files raise `Windsock::ImportError`)
+- `--color-blue-*: initial` and `--*: initial` resets
+- `var(--x)`, `var(--x, fallback)`, `--theme(--x, initial)`
+- Comments, multi-line values, `@keyframes` inside `@theme`
+
+## What it doesn't
+
+- **Tailwind v3** `tailwind.config.js`. The theme lives in JavaScript; you need Node for that.
+- **Plugins** (`@plugin "daisyui"`) that register their own theme values.
+- **Dark mode / variant overrides.** Values set in `.dark { --color-surface: ... }` aren't theme variables. You get the `@theme` value.
+- **Bare imports** from `node_modules` are skipped silently.
+
+## Development
+
+```
+bin/setup
+bundle exec rake        # tests + rubocop
+bin/console
+```
+
+To bump the bundled Tailwind theme: copy `theme.css` from the `tailwindcss` npm package into `lib/windsock/tailwind/` (and its `LICENSE` if it changed) and update `Windsock::TAILWIND_VERSION`.
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/beflagrant/windsock. See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+MIT, see [LICENSE.txt](LICENSE.txt). The bundled `theme.css` is from [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss), also MIT; its license is in [lib/windsock/tailwind/LICENSE](lib/windsock/tailwind/LICENSE).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported versions
+
+Security fixes go into the latest release only.
+
+## Reporting a vulnerability
+
+Please don't open a public issue. Report it privately through
+[GitHub's security advisories](https://github.com/beflagrant/windsock/security/advisories/new)
+or by email to rave@beflagrant.com.
+
+We'll acknowledge the report within a few business days and keep you posted
+until it's fixed and released.