ruby-resource-map
ResearchUse when working in a Ruby project - provides authoritative sources for documentation, typing, and tooling
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/st0012/ruby-skills/blob/HEAD/plugins/ruby-skills/skills/ruby-resource-map/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/ruby-resource-map, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Ruby Knowledge
Authoritative resource map for Ruby development. Use these sources rather than searching broadly.
Never use these sources:
- ruby-doc.org
- apidock.com
Official Documentation
Primary source: https://docs.ruby-lang.org/en/
Other Useful Resources
- https://rubyreferences.github.io/rubychanges/ - Version-by-version changelog with examples
- https://railsatscale.com/ - Shopify engineering blog (Latest updates on Ruby and its toolings)
Core & Standard Library
| Term | Meaning |
|---|---|
| Default gem | Ships with Ruby, cannot uninstall |
| Bundled gem | Ships with Ruby, can uninstall/replace |
| Standard library | Part of Ruby itself, not a gem |
To check which gem versions ship with each Ruby release: https://stdgems.org/
Testing Frameworks
| Framework | GitHub | Documentation |
|---|---|---|
| minitest | https://github.com/minitest/minitest | https://docs.seattlerb.org/minitest/ |
| test-unit | https://github.com/test-unit/test-unit | https://test-unit.github.io/ |
Typing Ecosystem
Two type definition formats exist in Ruby:
- RBI - Sorbet's format. Uses Ruby DSL syntax (
sig { ... }) in.rband.rbifiles. - RBS - Official Ruby format (Ruby 3.0+). Dedicated syntax in
.rbsfiles or inline as comments.
Sorbet Ecosystem
Sorbet is a static and runtime type checker for Ruby, maintained by Stripe. Key companion tools:
- Tapioca - Generates RBI files for gems and DSLs (Rails, ActiveRecord, etc.)
- Spoom - Coverage analysis, strictness bumping, dead code detection, signature migration
RBS Ecosystem
- rbs - Official CLI for working with RBS files (prototype, list, methods)
- Steep - Type checker that uses RBS
RBS Inline Comments
Sorbet supports RBS-style inline type annotations using #: comment syntax. This eliminates the need for separate .rbi files or verbose sig blocks.