Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/westonganger/rails_i18n_manager

Web interface to manage i18n translations helping to facilitate the editors of your translations. Provides a low-tech and complete workflow for importing, translating, and exporting your I18n translation files. Designed to allow you to keep the translation files inside your projects git repository where they should be.
https://github.com/westonganger/rails_i18n_manager

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/westonganger/rails_i18n_manager
Owner: westonganger
License: mit
Created: 2023-04-02T06:19:46.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-01-24T00:57:49.000Z (8 months ago)
Last Synced: 2024-07-05T14:53:14.889Z (3 months ago)
Language: Ruby
Homepage:
Size: 1.24 MB
Stars: 206
Watchers: 6
Forks: 9
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Rails I18n Manager
> A complete translation editor and workflow

Features:

- Import & export translations using standard i18n YAML/JSON files
- Allows managing translations for any number of apps
- Built in support for Google Translation for missing translations
- Provides an API end point to perform automated downloads of your translations

## Screenshots
![Screenshot](/screenshot_list.png)

![Screenshot](/screenshot_import.png)

![Screenshot](/screenshot_edit.png)

## Setup

Developed as a Rails engine. So you can add to any existing app or create a brand new app with the functionality.

First add the gem to your Gemfile

```ruby
### Gemfile
gem "rails_i18n_manager"
```

Then install and run the database migrations

```sh
bundle install
bundle exec rake rails_i18n_manager:install:migrations
bundle exec rake db:migrate
```

### Routes

#### Option A: Mount to a path

```ruby
### config/routes.rb

### As sub-path
mount RailsI18nManager::Engine, at: "/rails_i18n_manager", as: "rails_i18n_manager"

### OR as root-path
mount RailsI18nManager::Engine, at: "/", as: "rails_i18n_manager"
```

#### Option B: Mount to a subdomain

```ruby
### config/routes.rb

translations_engine_subdomain = "translations"

mount RailsI18nManager::Engine,
at: "/", as: "translations_engine",
constraints: Proc.new{|request| request.subdomain == translations_engine_subdomain }

not_engine = Proc.new{|request| request.subdomain != translations_engine_subdomain }

constraints not_engine do
# your app routes here...
end
```

### Configuration

```ruby
### config/initializers/rails_i18n_manager.rb

RailsI18nManager.config do |config|
config.google_translate_api_key = ENV.fetch("GOOGLE_TRANSLATE_API_KEY", nil)

### You can use our built-in list of all locales Google Translate supports
### OR make your own list. These need to be supported by Google Translate
# config.valid_locales = ["en", "es", "fr"]
end
```

### Customizing Authentication

```ruby
### config/routes.rb

### Using Devise
authenticated :user do
mount RailsI18nManager::Engine, at: "/rails_i18n_manager", as: "rails_i18n_manager"
end

### Custom devise-like
constraints ->(req){ req.session[:user_id].present? && User.find_by(id: req.session[:user_id]) } do
mount RailsI18nManager::Engine, at: "/rails_i18n_manager", as: "rails_i18n_manager"
end

### HTTP Basic Auth
with_http_basic_auth = ->(engine){
Rack::Builder.new do
use Rack::Auth::Basic do |username, password|
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV.fetch("RAILS_I18N_MANAGER_USERNAME"))) &&
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV.fetch("RAILS_I18N_MANAGER_PASSWORD")))
end
run(engine)
end
}
mount with_http_basic_auth.call(RailsI18nManager::Engine), at: "/rails_i18n_manager", as: "rails_i18n_manager"
```

### API Endpoint

We provide an endpoint to retrieve your translation files at `/translations`.

You will likely want to add your own custom authentication strategy and can do so using a routing constraint on the `mount RailsI18nManager` call.

From that point you can implement an automated mechanism to update your apps translations using the provided API end point. Some examples

An example in Ruby:

```ruby
require 'open-uri'

zip_stream = URI.open('https://translations-manager.example.com/translations.zip?export_format=yaml')
IO.copy_stream(zip_stream, '/tmp/my-app-locales.zip')
`unzip /tmp/my-app-locales.zip /tmp/my-app-locales/`
`rsync --delete-after /tmp/my-app-locales/my-app/ /path/to/my-app/config/locales/`
puts "Locales are now updated, app restart not-required"
```

A command line example using curl:

```
curl https://translations-manager.example.com/translations.zip?export_format=json -o /tmp/my-app-locales.zip \
&& unzip /tmp/my-app-locales.zip /tmp/my-app-locales/ \
&& rsync --delete-after /tmp/my-app-locales/my-app/ \
&& echo "Locales are now updated, app restart not-required"
```

## Development

Run migrations using: `rails db:migrate`

Run server using: `bin/dev` or `cd test/dummy/; rails s`

## Testing

```
bundle exec rspec
```

We can locally test different versions of Rails using `ENV['RAILS_VERSION']`

```
export RAILS_VERSION=7.0
bundle install
bundle exec rspec
```

## Other Translation Managers & Web Interfaces

For comparison, some other projects for managing Rails translations.

- https://github.com/tolk/tolk - This is the project that inspired rails_i18n_manager. UI and file-based approach. I [attempted to revive tolk](https://github.com/tolk/tolk/pull/161) but gave up as I found the codebase and workflow was really just a legacy ball of spagetti.
- https://github.com/prograils/lit
- https://github.com/alphagov/rails_translation_manager
- https://github.com/glebm/i18n-tasks

# Credits

Created & Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)