How do I install R18n for a Sinatra app?

Use the `sinatra-r18n` gem, include it in your Gemfile, and set up R18n configuration in your Sinatra application. The gem automatically handles locale detection and provides translation helpers similar to the core examples.

Can R18n load translations from a JSON file instead of YAML?

R18n primarily uses YAML, but you can create a custom loader to read from JSON or any source by implementing the `available` and `load` methods, as shown in the 'Total flexibility' section with the DBLoader example.

Is R18n compatible with Rails 7?

Check the `r18n-rails` gem documentation for version compatibility. Generally, it supports recent Rails versions, but you should verify with the project's GitHub releases or changelog, as maintenance might vary.

How does R18n handle pluralization compared to other i18n libraries?

R18n has built-in locale data for pluralization rules, so you define plurals in YAML with `!!pl` type, and it automatically selects the correct form based on locale, avoiding complex lambdas used in some alternatives.

R18n or Rails I18n: which should I choose?

If you need advanced features like custom filters, model translations, or more control, R18n is better. For standard use cases, Rails I18n is simpler and well-integrated with the framework, requiring less setup.

How to add a custom translation filter for HTML safety in R18n?

Use the built-in escape filter by marking translations with `!!escape` in YAML, or define a custom filter via `R18n::Filters.add` to apply HTML escaping logic, as demonstrated in the filters section of the README.

Open-Awesome

r18n

Ruby

An i18n tool for Ruby applications with a Ruby-style syntax, filters, model translation, and flexible locale support.

GitHub

513 stars65 forks0 contributors

What is r18n?

R18n is an internationalization tool for Ruby applications that manages translations into multiple languages. It provides a core library and framework-specific plugins to handle locale detection, pluralization, and custom translation logic. The tool solves the problem of adding multilingual support to Ruby apps with a clean, Ruby-like syntax.

Target Audience

Ruby developers building web applications (with Rails or Sinatra) or desktop applications that require multilingual support. It's also suitable for developers needing flexible, customizable i18n solutions beyond basic key-value translation.

Value Proposition

Developers choose R18n for its Ruby-native syntax, extensive flexibility (custom filters, loaders, and locale handling), and framework integrations. Its agnostic core allows deep customization while wrapper plugins simplify adoption in popular environments.

Overview

I18n tool to translate your Ruby application.

Use Cases

Best For

Adding multilingual support to Ruby on Rails applications
Internationalizing Sinatra web applications
Translating desktop or shell applications written in Ruby
Managing model translations in ActiveRecord or other ORMs
Implementing custom translation logic with filters (e.g., gender-based text)
Loading translations from databases or multiple YAML sources

Not Ideal For

Teams using JavaScript-heavy frontends who need client-side i18n integration without server-side Ruby.
Projects that prioritize minimal configuration and prefer Rails' convention-over-configuration I18n setup.
Applications requiring real-time translation updates from a content management system without code deployments.

Pros & Cons

Pros

Intuitive Ruby Syntax

Enables method-like access to translations (e.g., `t.user.edit`), making code cleaner and more readable for Rubyists, as shown in the quick demo with YAML-defined keys.

Advanced Filter System

Supports custom filters for scenarios like gender-based variations, Markdown rendering, and HTML escaping, allowing complex translation logic without core modifications, as detailed in the filters section.

Seamless Model Integration

Translates ORM model attributes with minimal code via `R18n::Translated`, demonstrated with ActiveRecord examples, streamlining multilingual data handling in Ruby applications.

Smart Locale Detection

Automatically infers user preferences from HTTP headers with intelligent fallback chains, reducing manual locale management in web apps, as explained in the auto-detect section.

Cons

Configuration Complexity

Setting up custom loaders or filters requires deeper understanding of R18n's API, such as implementing `available` and `load` methods, which can be time-consuming compared to plug-and-play libraries.

Limited Third-Party Tooling

While services like Crowdin are supported, the ecosystem around R18n is smaller than Rails I18n, potentially limiting integration options and community-driven extensions.

Performance Overhead Risk

The flexible architecture, including dynamic filter application and agnostic design, may introduce runtime overhead in high-throughput applications compared to optimized, static i18n solutions.

Frequently Asked Questions

Related Projects

rails-i18n

Repository for collecting Locale data for Ruby on Rails I18n as well as other interesting, Rails related I18n stuff

Stars4,032

Forks2,686

Last commit14 days ago

globalize

Rails I18n de-facto standard library for ActiveRecord model/data translation.

Stars2,156

Forks501

Last commit6 days ago

i18n-tasks

Manage translation and localization with static analysis, for Ruby i18n