/missing_text

Rails engine for traversing the locale directory and detecting missing translations

Primary LanguageRubyMIT LicenseMIT

MissingText

MissingText is a rails engine for detecting missing translations from your locale files. The web interface allows full visiblity of missing translations by file, allowing you to revisit and clear sessions.

Installing

To install the gem:

$ gem install 'missing_text'

Add it to the gemfile development and rebundle.

group :development do
	gem 'missing_text'
end

Next run migrations in order to create the database records

$ rake missing_text:install:migrations

Then run rake db:migrate to create the tables.

Next we need to create the initializer for MissingText. This will be installed in config/initializers/missing_text.rb. This file can be edited to change startup options.

$ rails generate initializer missing_text

Finally we need to mount the engine in routes.rb

Example::Application.routes.draw do
  root :to => 'home#index'

  mount MissingText::Engine => '/missing_text' if Rails.env.development?
end

It is strongly recommended that MissingText only run in development.

Configuration Options

  • MissingText.locale_root - The directory where all of the locale files live. An additional directory can be specified if your locales are in a location other than the default config/locales/. This is a relative path and will be appended to Rails.root.
  • MissingText.skip_directories - Include any directories in MissingText.locale_root that you would like to skip. By default this will be appended to . and ... Please make these paths relative to your MissingText.locale_root. This is an empty array by default.
  • MissingText.search_direct_locale- Include the search of the locale root itself (e.g. config/locales) when looking for missing translations. This is true by default.
  • MissingText.skip_patterns - An array of regexes that specify what kind of files to skip. For example, if you have both an "en.yml" and an "en-UK.yml", but you would not like the diff operation to be performed on these two, you can add /en-uk.yml/.

Integration with Whenever

If you would like to run MissingText as a cronjob and are using Whenever, add the following to your schedule.rb file.

every 10.days, :at => '2:30 am' do
  runner 'MissingText::Runner.run', :environment => ...
end

This will run as though it is being run from the web interface and will create a batch for that current time.

Development and Contribution

I would love to have others contribute. Email me at chris.sandison@gmail.com if you have questions, suggestions, or want to discuss. Otherwise, you know the drill:

  1. Fork it (https://github.com/ChrisSandison/missing_text/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git push origin my-new-feature)
  4. Create a new Pull Request

Please feel free to create issues if you find any bugs and I will respond as best as I can.