ObjectFramework Guides (v1.0.0)
These guides teach you to build Ruby applications from collaborating objects. Start with a plain use case, grow it into an order-confirmation application, and understand how its objects, transactions, HTTP, and gRPC fit together.
Foundations
- Your first application
- Start with a Ruby object, compose an application, and run a complete intention.
- Objects and responsibilities
- Build order confirmation and decide which object owns each business and application decision.
- Composition and execution
- Give collaborators an execution scope, validate startup, and make resource ownership explicit.
Application data
- Data Mapper and sessions
- Store independent values while preserving object identity and tracking changes inside a session.
- Queries and associations
- Compose queries, load explicit object graphs, and understand when changes become visible.
Transports and failures
- Building an HTTP API
- Turn an order-confirmation intention into a JSON endpoint with explicit input and response boundaries.
- Failures and observability
- Translate meaningful exceptions safely and distinguish rollback from failures after commit.
Beyond the first endpoint
- SQLite and schema evolution
- Replace volatile storage, evolve a database, and reason about locks, deadlines, and durable commits.
- gRPC and streaming
- Export contracts, reuse the same use case, and keep streaming transactions bounded by messages.
- Concurrency and Ruby capabilities
- Follow ownership through request threads, flow control, cancellation, Ruby Box, Ractor, and JITs.
Contributing
- Testing and extending
- Make a change with TDD, follow the storage contract, and add modules without hidden dependencies.
API reference
Look up classes, method signatures, and contracts in the RDoc reference. Use its search to find an object or method while you read.
Open the full API reference, or jump to application composition, persistence sessions, HTTP, and gRPC services.
Read the code alongside the guides
The examples are versioned with the framework and run in its test suite. When a guide shows a full example, its source link opens the exact program. Explanations also point to implementation tests, so you can follow a claim to executable evidence.
Ruby Box, Ractor, and JIT features are optional. The core framework runs on Ruby 4.0.8; SQLite is its sole optional runtime gem.