rails_i18n_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cb2ef95ffdfb5f8460ccf2ff0b855e308a31d4375c8b90d977c48160323880c
+  data.tar.gz: 78060ff50be1952e29a7113766b4aaccf48b1bf9b9394236b1259c8dd1e43e98
+SHA512:
+  metadata.gz: '09dbe770f9e2d99e94c522e313ea3483b2546c0ee9edaa06e907335ade487abe300c931b1415c29f4395917a726c76bdea58089d8e6e296dd154847211b597ce'
+  data.tar.gz: 32d1836c17e69a9a9b9f7cae727415def212fde9d01d6c63dc1cfa9a94551a88654a1629ae15f536067ee0fcbab37c38b5f053863aee7bf72edcc5a5aed81646

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Weston Ganger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,177 @@
+# Rails I18n Manager
+> A complete translation editor and workflow
+
+<a href='https://github.com/westonganger/rails_i18n_manager/actions' target='_blank'><img src="https://github.com/westonganger/rails_i18n_manager/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+
+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.
+
+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)
+<br><br>
+![Screenshot](/screenshot_import.png)
+<br><br>
+![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", git: "https://github.com/westonganger/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']` and different database gems using `ENV['DB_GEM']`
+
+```
+export RAILS_VERSION=7.0
+export DB_GEM=sqlite3
+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)

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+task :test do
+  system("rspec", out: STDOUT)
+end
+
+task default: :test

data/app/controllers/rails_i18n_manager/application_controller.rb

@@ -0,0 +1,5 @@
+module RailsI18nManager
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/rails_i18n_manager/translation_apps_controller.rb

@@ -0,0 +1,71 @@
+module RailsI18nManager
+  class TranslationAppsController < ApplicationController
+    before_action :set_translation_app, only: [:show, :edit, :update, :destroy]
+
+    def index
+      @translation_apps = TranslationApp
+        .sort_order(params[:sort], params[:direction], base_sort_order: "#{TranslationApp.table_name}.name ASC")
+        .multi_search(params[:search])
+        .page(params[:page])
+    end
+
+    def new
+      @translation_app = TranslationApp.new
+      render "form"
+    end
+
+    def create
+      @translation_app = TranslationApp.new(permitted_params)
+
+      if @translation_app.save
+        flash[:notice] = "Successfully created."
+        redirect_to action: :edit, id: @translation_app.id
+      else
+        flash.now[:error] = "Create failed."
+        render "rails_i18n_manager/translation_apps/form"
+      end
+    end
+
+    def show
+      redirect_to action: :edit
+    end
+
+    def edit
+      render "form"
+    end
+
+    def update
+      if @translation_app.update(permitted_params)
+        flash[:notice] = "Update success."
+        redirect_to action: :index
+      else
+        flash.now[:error] = "Update failed."
+        render "rails_i18n_manager/translation_apps/form"
+      end
+    end
+
+    def destroy
+      if @translation_app.destroy
+        flash[:notice] = "Deleted '#{@translation_app.name}'"
+      else
+        flash[:alert] = "Delete failed"
+      end
+      redirect_to action: :index
+    end
+
+    private
+
+    def set_translation_app
+      @translation_app = TranslationApp.find_by!(id: params[:id])
+    end
+
+    def set_browser_title
+      @browser_title = TranslationApp::NAME.pluralize
+    end
+
+    def permitted_params
+      params.require(:translation_app).permit(:name, :default_locale, additional_locales: [])
+    end
+
+  end
+end

data/app/controllers/rails_i18n_manager/translations_controller.rb

@@ -0,0 +1,248 @@
+module RailsI18nManager
+  class TranslationsController < ApplicationController
+    before_action :get_translation_key, only: [:show, :edit, :update, :destroy]
+
+    def index
+      case params[:sort]
+      when "app_name"
+        sort = "#{TranslationApp.table_name}.name"
+      when "updated_at"
+        sort = "#{TranslationKey.table_name}.updated_at"
+      else
+        sort = params[:sort]
+      end
+
+      @translation_keys = TranslationKey
+        .includes(:translation_app, :translation_values)
+        .references(:translation_app)
+        .sort_order(sort, params[:direction], base_sort_order: "#{TranslationApp.table_name}.name ASC, #{TranslationKey.table_name}.key ASC")
+
+      apply_filters
+
+      if request.format.to_sym != :html && TranslationApp.first.nil?
+        request.format = :html
+        flash[:alert] = "No Translation apps exists"
+        redirect_to action: :index
+        return false
+      end
+
+      respond_to do |format|
+        format.html do
+          @translation_keys = @translation_keys.page(params[:page])
+        end
+
+        format.any do
+          @translations_keys = @translation_keys.where(active: true) ### Ensure exported keys are active for any exports
+
+          case request.format.to_sym
+          when :csv
+            send_data @translation_keys.to_csv, filename: "translations.csv"
+          when :zip
+            file = @translation_keys.export_to(format: params[:export_format], zip: true, app_name: params[:app_name].presence)
+
+            if file
+              send_file file, filename: "translations-#{params[:export_format]}-#{params[:app_name].presence || "all-apps"}.zip"
+            else
+              flash[:alert] = "Sorry, Nothing to export"
+              redirect_to action: :index
+            end
+          else
+            raise ActionController::UnknownFormat
+          end
+        end
+      end
+    end
+
+    def show
+      render "edit"
+    end
+
+    def edit
+    end
+
+    def update
+      @translation_key.assign_attributes(allowed_params)
+
+      if @translation_key.save
+        flash[:notice] = "Update success."
+        redirect_to edit_translation_path(@translation_key)
+      else
+        flash[:notice] = "Update failed."
+        render "translations/edit"
+      end
+    end
+
+    def destroy
+      if @translation_key.active
+        redirect_to translations_path, alert: "Cannot delete active translations"
+      else
+        @translation_key.destroy!
+        redirect_to translations_path, notice: "Delete Successful"
+      end
+    end
+
+    def delete_inactive_keys
+      @translation_keys = TranslationKey
+        .where(active: false)
+        .includes(:translation_app, :translation_values)
+        .references(:translation_app)
+
+      apply_filters
+
+      ids = translation_keys.pluck(:id)
+
+      TranslationKey.where(id: ids).delete_all
+      TranslationValue.where(translation_key_id: ids).delete_all
+    end
+
+    def import
+      @form = Forms::TranslationFileForm.new(params[:import_form])
+
+      if request.get?
+        render
+      else
+        if @form.valid?
+          begin
+            TranslationsImportJob.new.perform(
+              translation_app_id: @form.translation_app_id,
+              import_file: @form.file.path,
+              overwrite_existing: @form.overwrite_existing,
+              mark_inactive_translations: @form.mark_inactive_translations,
+            )
+          rescue TranslationsImportJob::ImportAbortedError => e
+            flash.now.alert = e.message
+            render
+            return
+          end
+
+          redirect_to translations_path, notice: "Import Successful"
+        else
+          flash.now.alert = "Import not started due to form errors."
+          render
+        end
+      end
+    end
+
+    def translate_missing
+      @translation_keys = TranslationKey.includes(:translation_values)
+
+      apply_filters
+
+      translated_count = 0
+      total_missing = 0
+
+      if params[:app_name]
+        app_locales = TranslationApp.find_by(name: params[:app_name]).additional_locales_array
+      else
+        @translation_keys = @translation_keys.includes(:translation_app)
+      end
+
+      ### Check & Translate for Every i18n key
+      @translation_keys.each do |key_record|
+        locales = (app_locales || key_record.translation_app.additional_locales_array)
+
+        ### Filter to just google translate supported languages
+        locales = locales.intersection(GoogleTranslate.supported_locales)
+
+        default_translation_text = key_record.default_translation
+
+        next if default_translation_text.blank?
+
+        locales.each do |locale|
+          if locale == key_record.translation_app.default_locale
+            next ### skip, we dont translate the default locale
+          end
+
+          val_record = key_record.translation_values.detect{|x| x.locale == locale.to_s }
+
+          ### Translate Missing
+          if val_record.nil? || val_record.translation.blank?
+            total_missing += 1
+
+            translated_text = GoogleTranslate.translate(
+              default_translation_text,
+              from: key_record.translation_app.default_locale,
+              to: locale
+            )
+
+            if translated_text.present?
+              if val_record.nil?
+                val_record = key_record.translation_values.new(locale: locale)
+              end
+
+              val_record.assign_attributes(translation: translated_text)
+
+              val_record.save!
+
+              translated_count += 1
+            end
+          end
+        end
+      end
+
+      if params[:translation_key_id]
+        url = request.referrer || translation_path(params[:translation_key_id])
+      else
+        url = params.to_unsafe_h.merge(action: :index)
+      end
+
+      redirect_to url, notice: "Translated #{translated_count} of #{total_missing} total missing translations"
+    end
+
+    private
+
+    def get_translation_key
+      @translation_key = TranslationKey.includes(:translation_values).find_by!(id: params[:id])
+    end
+
+    def allowed_params
+      params.require(:translation_key).permit(translation_values_attributes: [:id, :locale, :translation])
+    end
+
+    def apply_filters
+      if params[:app_name].present?
+        @translation_keys = @translation_keys.joins(:translation_app).where(TranslationApp.table_name => {name: params[:app_name]})
+      end
+
+      if params[:translation_key_id].present?
+        @translation_keys = @translation_keys.where(id: params[:translation_key_id])
+      end
+
+      if request.format.html?
+        ### ONLY FOR HTML - SO THAT WE DONT DOWNLOAD INCOMPLETE TRANSLATION EXPORT PACKAGES
+
+        if params[:search].present?
+          @translation_keys = @translation_keys.search(params[:search])
+        end
+
+        if params[:status] == "Inactive"
+          @translation_keys = @translation_keys.where(active: false)
+        elsif params[:status] == "All"
+          # Do nothing
+        else
+          @translation_keys = @translation_keys.where(active: true)
+        end
+
+        if params[:status] == "Missing"
+          missing_key_ids = []
+          TranslationApp.all.each do |app_record|
+            app_record.translation_keys.includes(:translation_values).each do |key_record|
+              if key_record.translation_values.size != app_record.all_locales.size
+                missing_key_ids << key_record.id
+              end
+            end
+          end
+
+          @translation_keys = @translation_keys
+            .references(:translation_values)
+            .where("#{TranslationValue.table_name}.translation IS NULL OR #{TranslationKey.table_name}.id IN (:ids)", ids: missing_key_ids)
+        end
+      end
+    end
+
+    def set_browser_title
+      @browser_title = "Translations"
+    end
+
+  end
+end

data/app/helpers/rails_i18n_manager/application_helper.rb

@@ -0,0 +1,74 @@
+module RailsI18nManager
+  module ApplicationHelper
+
+    def custom_form_for(*args, **options, &block)
+      options[:builder] = CustomFormBuilder
+      if options.has_key?(:defaults)
+        @_custom_form_for_defaults = options.delete(:defaults)
+      end
+      form_for(*args, options, &block)
+    end
+
+    def custom_fields_for(*args, **options, &block)
+      options[:builder] = CustomFormBuilder
+      if options.has_key?(:defaults)
+        @_custom_form_for_defaults = options.delete(:defaults)
+      end
+      fields_for(*args, options, &block)
+    end
+
+    ASSET_VERSION = `git show -s --format=%ci`.parameterize.freeze
+    def custom_asset_path(path)
+      "#{path}?v=#{Rails.env.development? ? Time.now.to_i : ASSET_VERSION}"
+    end
+
+    def breadcrumb_item(title, url=nil)
+      if url.nil?
+        %Q(<span class="breadcrumb-item">#{title}</span>).html_safe
+      else
+        %Q(<span class="breadcrumb-item"><a href="#{url}">#{title}</a></span>).html_safe
+      end
+    end
+
+    def sort_link(attr_name, label=nil)
+      if label.blank?
+        label = attr_name.to_s.titleize
+      end
+
+      direction = params[:direction].present? && params[:direction].casecmp?("asc") ? 'desc' : 'asc'
+
+      link_to label, params.to_unsafe_h.merge(sort: attr_name, direction: direction)
+    end
+
+    def nav_link(name, url, html_options={}, &block)
+      url = url_for(url)
+
+      if html_options.has_key?(:active)
+        active = html_options.delete(:active)
+      elsif url == (url.include?("?") ? request.fullpath : request.path)
+        active = true
+      end
+
+      html_options[:class] ||= ""
+
+      html_options[:class] += " nav-link"
+
+      if active
+        html_options[:class] += " active"
+      end
+
+      html_options[:class].strip!
+
+      content_tag(:li, class: "nav-item #{'active' if active}".strip) do
+        link_to(name, url, html_options) + (
+          if block_given?
+            content_tag(:ul) do
+              capture(&block)
+            end
+          end
+        )
+      end
+    end
+
+  end
+end