kaspernj / awesome_translations Goto Github PK

Semi-automatic maintenance of most translations in a Rails app.

License: MIT License

Ruby 83.13% CSS 0.34% HTML 15.54% Liquid 0.25% JavaScript 0.18% SCSS 0.34% Haml 0.21%

awesome_translations's Introduction

AwesomeTranslations

Install

gem 'awesome_translations'
gem 'sqlite3', group: :development

AT uses SQLite3 for creating a database containing a farily large cache.

Then run the following:

bundle exec rake awesome_translations:install

Insert this into your "routes.rb" file:

mount AwesomeTranslations::Engine => "/awesome_translations" if Rails.env.development?

Translations under controllers and models

If you want to do translations from your models or controllers, you will need to add this to a new initializer file under "config/initializers/awesome_translations.rb"

AwesomeTranslations.load_object_extensions

If you don't like monkey patching the Object-class, you can also include it into ApplicationRecord' by inserting something like this to allow t-method-calls from inside models:

class ApplicationRecord < ActiveRecord::Base
  include AwesomeTranslations::TranslateFunctionality
end

You will also need to modify the line in your Gemfile a bit:

gem 'awesome_translations'

Helper translations

The t-method translates like from inside a view in Rails. To get around this, you can call 'helper_t' instead. Start by including that method in your helpers by adding this to ApplicationHelper:

module ApplicationHelper
  include AwesomeTranslations::ViewsHelper
end

Controller translations without action in key

Start by including this in your ApplicationController:

class ApplicationController
  include AwesomeTranslations::ControllerTranslateFunctionality

Then you can use the controller_t-method like this:

class UsersController < ApplicationController
  def create
    flash[:notice] = controller_t('.user_was_saved')
  end
end

This is an example of how it works and what the difference is:

module ApplicationHelper
  include AwesomeTranslations::ApplicationHelper

  # Sample method with translation
  def hello_world
    t('.hello_world') #=> translates with key '#{controller_name}.#{action_name}.hello_world'
    return helper_t('.hello_world') #=> translates with key 'helpers.application_helper.hello_world'
  end
end

Translating your application

Start a Rails server for your project and go to the namespace called something like "http://localhost:3000/awesome_translations". Start translating your app through the webinterface.

License

This project rocks and uses MIT-LICENSE.

awesome_translations's People

Contributors

Stargazers

Watchers

Forkers

danielfriis gfish ar31an robwu

awesome_translations's Issues

Support for validates_confirmation_of

Looks like helper-translations gets thrown under the current views key. Could be awesome if it was possible to change that into going under something like "helpers.tasks.#{key}" instead by calling the functionality in a initializer like with ObjectExtensions.

WillPaginate support

Make helper class with methods like "ModelInspector.engines"

Depend on ActiveRecordTransactioner 0.0.7 - otherwise it will crash on cache update

ModelHandler should handle subclasses

Like:

ShippingAddress < Address
BillingAddress < Address
Address < ActiveRecord::Base

Don't show files with no translations. Or make option to show them maybe?

General translations should have own handler

General translations are the one which doesn't start with "."

Implement handler for the general translations.
ERB handler should ignore general translations.

Move/merge existing translations to correct positions in AT namespace

Date- and time translations handler for Rails

Devise support

Changed computer name causes AT to fail updates

Task: https://tasks.kaspernj.org/tasks/3987

I changed computer and computer name recently, which causes AT to fail updates to db. I get the following error message:

Permission denied @ dir_s_mkdir - /Users/[OLD_USERNAME]

Support for Money gem (price_cents => price)

Detect and remove duplicate translations in the AT namespace

Rails 5 support

Currently awesome_translations depends on rails (< 5.0.0, >= 3.0.0). Would be awesome with Rails 5 support!

Show only unfinished translations

Maybe some sort of focus-mode where you're just presented one translation at a time. You do the translation, hit enter, and the next unfinished translation comes in focus.