Thank you for helping improve the Ruby member of the ArchUnitEverything family. Small, focused changes with tests are easiest to review.
- Search the existing issues.
- Use an issue for behavior changes or larger additions so the Ruby API can stay aligned with the sibling implementations.
- Read AGENTS.md for architecture, naming, and fluent-API conventions.
- Never include credentials, private project source, or customer data in an issue or fixture.
ArchUnitRuby requires Ruby 3.3 or newer.
git clone https://github.com/LukasNiessen/ArchUnitRuby.git
cd ArchUnitRuby
bundle install
bundle exec rakebundle exec rake validates development release metadata, then runs the randomized RSpec suite and
RuboCop. Before submitting documentation or
public API changes, also run:
COVERAGE=true bundle exec rspec
bundle exec rake docs
gem build archunit.gemspec --strictThe coverage suite enforces at least 98% line and 90% branch coverage on every lib/**/*.rb runtime
file, including unloaded files. Specs, benchmarks, and development scripts do not contribute to
the enforced denominator. A subprocess regression test verifies the actual filtered report and
thresholds without merging its partial probe execution into the full suite. Native symlink tests
may be skipped on Windows accounts without link privileges; Linux CI exercises those scenarios.
The documentation task builds
the complete site, checks the public API guide, rejects unrendered Markdown, and validates internal
links.
Run bundle exec rake security separately to refresh advisories and scan the locked development
and runtime dependencies. See SECURITY.md for report locations and offline usage.
The normal test suite uses a synthetic local advisory and never fetches vulnerability data.
For a stable release, follow the pre-release checklist and
publishing guide. Development allows an unreleased changelog heading and
installation instructions for the published gem. The separate --release metadata check requires
a valid dated heading and an installation example targeting the version being published.
- Write the fluent sentence first and read it aloud.
- Prefer idiomatic Ruby when a sibling convention conflicts with the language.
- Keep builders immutable and lazy; only terminals perform analysis.
- Return structured violations for architecture disagreements—do not raise until the assertion boundary.
- Add a focused unit test and an end-to-end fluent API test for behavior changes.
- Keep
# frozen_string_literal: truein Ruby files and leave RuboCop clean. - Update
README.md,API.md, andCHANGELOG.mdwhen public behavior changes.
A useful pull request explains the user-facing problem, the chosen behavior, any deliberate cross-language difference, and how it was tested. Please keep unrelated formatting or refactors out of the same change.
By participating, you agree to follow the Code of Conduct. Security reports must follow SECURITY.md, not a public issue.