rails_i18n_manager 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: defa73fd31070325ba7285823e0a03ace7ab8c9a5808030f26638c0019de1acd
-  data.tar.gz: 11ea4841b06c54736b5be651d5d8e50d7bb232e4aedbfeaa82f7c9883bf7b4e7
+  metadata.gz: 754d64695feb342f539cf20c2f7e0eb56307d347c09a0aff1ee2dd6424bef236
+  data.tar.gz: dc20afbd566dd69f283f8e520fa523d551ece87e00bc8d2dc7361f7043890a1f
 SHA512:
-  metadata.gz: 95c8a9c7e660fbe4b3294eca65aceda6a3dd0c550acb41cf7abdb1aa4c585e45c529cee2b81d18ac692039d5525c07ae6b80c8a242963ff388cbd12f13db9f20
-  data.tar.gz: 79fd6614787767d5173d5b5812515dc7118f4dcfe2d9583a160c61b8760b13f7b06e8baaa5cb4a09c9ab1a60213d933d87c753db7f68881ef4ac71435d3299b0
+  metadata.gz: 9c7271c5b764f6730d8fdb33e31e936b9ceb738391d170f663ec133543eddaf52843b24bd20ebf97c671d507e1193dcae0671c25d6bdfcca27a9f2d737f040f0
+  data.tar.gz: d1c51faed0c9049ca72c9c6891a531338fcdcc183d08dc65bf3de3d558328bb1cdddfca96b99eef5500ac1b409d66c26563b0fa1ff8a069e770ed04722815538

data/README.md

@@ -142,6 +142,88 @@ curl https://translations-manager.example.com/translations.zip?export_format=jso
   && echo "Locales are now updated, app restart not-required"
 ```
 
+## Recommended Workflow for Teams
+
+It is desirable to reduce how often import/export is performed. It is also desirable that we do not violate the regular PR lifecycle/process. The following workflow should allow for this.
+
+When creating a PR you can just create a new YAML file named after your feature name or ticket number and then use the following format:
+
+```yaml
+# config/locales/some_new_feature.yml
+
+en:
+  some_new_key: "foo"
+fr:
+  some_new_key: "bar"
+es:
+  some_new_key: "baz"
+```
+
+Whenever releasing a new version of your application, pre-deploy or some other cadence, then you can have a step where all translation files are uploaded to the `rails_i18n_manager`, have your translator folks double check everything, then export your new files and cleanup all the feature files.
+
+## Recommended I18n Configuration
+
+The default I18n backend has some glaring issues
+
+- It will silently show "translation_missing" text which is very undesirable
+- It will not fallback to your default or any other locale
+
+You can avoid these issues using either of the techniques below
+
+```ruby
+# config/initializers/i18n.rb
+
+Rails.configuration do |config|
+  config.i18n.raise_on_missing_translations = true # WARNING: this will raise exceptions in Production too, preventing your users from using your application even when some silly little translation  is missing
+
+  config.i18n.fallbacks = [I18n.default_locale, :en].uniq # fallback to default locale, or if that is missing then fallback to english translation
+end
+```
+
+You will likely find that `raise_on_missing_translations` is too aggressive. Causing major outages just because a translation is missing. In that scenario its better to use something like the following:
+
+```ruby
+# config/initializers/i18n.rb
+
+Rails.configuration do |config|
+  config.i18n.raise_on_missing_translations = false # Instead we use the custom backend below
+
+  config.i18n.fallbacks = [I18n.default_locale, :en].uniq # fallback to default locale, or if that is missing then fallback to english translation
+end
+
+module I18n
+  class CustomI18nBackend
+    include I18n::Backend::Base
+
+    def translate(locale, key, options = EMPTY_HASH)
+      if !key.nil? && key.to_s != "i18n.plural.rule"
+        translation_value = lookup(locale, key, options[:scope], options)
+
+        if translation_value.blank?
+          if Rails.env.production?
+            # send an email or some other warning mechanism
+          else
+            # Raise exception in non-production environments
+            raise "Translation not found (locale: #{locale}, key: #{key})"
+          end
+        end
+      end
+
+      return nil # allow the Backend::Chain to continue to the next backend
+    end
+  end
+end
+
+if I18n.backend.is_a?(I18n::Backend::Chain)
+  I18n.backend.backends.unshift(I18n::CustomI18nBackend)
+else
+  I18n.backend = I18n::Backend::Chain.new(
+    I18n::CustomI18nBackend,
+    I18n.backend, # retain original backend
+  )
+end
+```
+
 ## Development
 
 Run migrations using: `rails db:migrate`

data/app/controllers/rails_i18n_manager/translation_apps_controller.rb

@@ -40,7 +40,7 @@ module RailsI18nManager
         redirect_to action: :index
       else
         flash.now[:error] = "Update failed."
-        render "rails_i18n_manager/translation_apps/form"
+        render "form"
       end
     end
 

data/app/controllers/rails_i18n_manager/translations_controller.rb

@@ -36,12 +36,16 @@ module RailsI18nManager
 
           case request.format.to_sym
           when :csv
+            if params.dig(:filters, :app_name).present?
+              @translation_keys = @translation_keys.joins(:translation_app).where(TranslationApp.table_name => {name: params.dig(:filters, :app_name)})
+            end
+
             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)
+            file = @translation_keys.export_to(format: params[:export_format], zip: true, app_name: params.dig(:filters, :app_name).presence)
 
             if file
-              send_file file, filename: "translations-#{params[:export_format]}-#{params[:app_name].presence || "all-apps"}.zip"
+              send_file file, filename: "translations-#{params[:export_format]}-#{params.dig(:filters, :app_name).presence || "all-apps"}.zip"
             else
               flash[:alert] = "Sorry, Nothing to export"
               redirect_to action: :index
@@ -68,7 +72,7 @@ module RailsI18nManager
         redirect_to edit_translation_path(@translation_key)
       else
         flash[:notice] = "Update failed."
-        render "translations/edit"
+        render "edit"
       end
     end
 
@@ -89,10 +93,10 @@ module RailsI18nManager
 
       apply_filters
 
-      ids = translation_keys.pluck(:id)
+      @translation_keys.destroy_all
 
-      TranslationKey.where(id: ids).delete_all
-      TranslationValue.where(translation_key_id: ids).delete_all
+      flash[:notice] = "Delete Inactive was successful."
+      redirect_to translations_path(filters: params[:filters].to_unsafe_h)
     end
 
     def import
@@ -132,8 +136,8 @@ module RailsI18nManager
       translated_count = 0
       total_missing = 0
 
-      if params[:app_name]
-        app_locales = TranslationApp.find_by(name: params[:app_name]).additional_locales_array
+      if params.dig(:filters, :app_name)
+        app_locales = TranslationApp.find_by(name: params.dig(:filters, :app_name)).additional_locales_array
       else
         @translation_keys = @translation_keys.includes(:translation_app)
       end
@@ -184,7 +188,7 @@ module RailsI18nManager
       if params[:translation_key_id]
         url = request.referrer || translation_path(params[:translation_key_id])
       else
-        url = params.to_unsafe_h.merge(action: :index)
+        url = translations_path(filters: params[:filters].to_unsafe_h)
       end
 
       redirect_to url, notice: "Translated #{translated_count} of #{total_missing} total missing translations"
@@ -201,8 +205,8 @@ module RailsI18nManager
     end
 
     def apply_filters
-      if params[:app_name].present?
-        @translation_keys = @translation_keys.joins(:translation_app).where(TranslationApp.table_name => {name: params[:app_name]})
+      if params.dig(:filters, :app_name).present?
+        @translation_keys = @translation_keys.joins(:translation_app).where(TranslationApp.table_name => {name: params.dig(:filters, :app_name)})
       end
 
       if params[:translation_key_id].present?
@@ -212,24 +216,40 @@ module RailsI18nManager
       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])
+        if params.dig(:filters, :search).present?
+          @translation_keys = @translation_keys.search(params.dig(:filters, :search))
+        end
+
+        if params.dig(:filters, :status).blank?
+          params[:filters] ||= {}
+          params[:filters][:status] = "All Active Translations"
         end
 
-        if params[:status] == "Inactive"
+        if params.dig(:filters, :status) == "Inactive Translations"
           @translation_keys = @translation_keys.where(active: false)
-        elsif params[:status] == "All"
+        elsif params.dig(:filters, :status) == "All Translations"
           # Do nothing
-        else
+        elsif params.dig(:filters, :status) == "All Active Translations"
           @translation_keys = @translation_keys.where(active: true)
-        end
-
-        if params[:status] == "Missing"
+        elsif params.dig(:filters, :status).start_with?("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
+
+          if params.dig(:filters, :app_name).present?
+            translation_apps = TranslationApp.where(name: params.dig(:filters, :app_name))
+          else
+            translation_apps = TranslationApp.all
+          end
+
+          translation_apps.includes(translation_keys: [:translation_values]).each do |app_record|
+            app_record.translation_keys.each do |key_record|
+              if params.dig(:filters, :status) == "Missing Default Translation"
+                if key_record.translation_values.detect{|x| x.locale == app_record.default_locale}&.translation.blank?
+                  missing_key_ids << key_record.id
+                end
+              else
+                if key_record.any_missing_translations?
+                  missing_key_ids << key_record.id
+                end
               end
             end
           end

data/app/views/layouts/rails_i18n_manager/_utility_css.html.erb

@@ -1,4 +1,10 @@
 <style>
+  .pull-left{
+    float: left !important;
+  }
+  .pull-right{
+    float: right !important;
+  }
   .space-left{
     margin-left:5px !important;
   }

data/app/views/rails_i18n_manager/translations/_filter_bar.html.slim

@@ -1,17 +1,18 @@
 form
   .row.align-items-center.g-1
     .col-auto
-      = select_tag :app_name, options_for_select(RailsI18nManager::TranslationApp.order(name: :asc).pluck(:name), params[:app_name]), prompt: "All Apps", class: "form-select", style: "min-width: 220px"
+      = select_tag "filters[app_name]", options_for_select(RailsI18nManager::TranslationApp.order(name: :asc).pluck(:name), params.dig(:filters, :app_name)), prompt: "All Apps", class: "form-select", style: "min-width: 220px"
 
     .col-auto
-      = select_tag :status, options_for_select([["All Active", nil], "Missing", "Inactive", "All"], params[:status]), class: 'form-select', style: "min-width: 135px;"
+      = select_tag :status, options_for_select(["All Translations", "All Active Translations", "Inactive Translations", "Missing Default Translation", "Missing Any Translation"], params.dig(:filters, :status)), class: 'form-select', style: "min-width: 215px;"
 
     .col-auto
-      = text_field_tag :search, params[:search], placeholder: "Search", class: "form-control"
+      = text_field_tag :search, params.dig(:filters, :search), placeholder: "Search", class: "form-control"
 
     .col-auto
       button.btn.btn-primary.btn-sm type="submit" Filter
 
-      - if [:app_name, :search].any?{|x| params[x].present? }
-        - link_params = {status: params[:status]}.select{|_,v| v.present?}
-        = link_to "Clear", link_params, class: "btn btn-sm space-left"
+      - if params.dig(:filters, :app_name).present? || params.dig(:filters, :search).present?
+        - if params.dig(:filters, :status).present?
+          - link_params = {filters: {status: params.dig(:filters, :status)}}
+        = link_to "Clear", (link_params || {}), class: "btn btn-sm space-left"

data/app/views/rails_i18n_manager/translations/index.html.slim

@@ -1,19 +1,19 @@
 .pull-right
-  = link_to "Translate with Google", params.to_unsafe_h.merge(action_name: :translate_missing), class: "btn btn-primary btn-sm", "data-confirm" => "Are you sure you want to proceed with translating the missing translations in the currently filtered list?"
+  = link_to "Translate with Google", translate_missing_translations_path(filters: params[:filters].to_unsafe_h), class: "btn btn-primary btn-sm", "data-method" => "post", "data-confirm" => "Are you sure you want to proceed with translating the missing translations in the currently filtered list?"
   = link_to "Import Translations", import_translations_path, class: "btn btn-secondary btn-sm space-left2"
-  = link_to "Delete Inactive", params.to_unsafe_h.merge(action_name: :delete_inactive_keys), class: "btn btn-danger btn-sm space-left2", data: {confirm: "Warning! This is a highly destructive action.\n\nIts possible to incorrectly upload an incomplete or incorrect file to 'Mark Inactive Translations from Source' which can leave you with inactive keys that maybe shouldnt have been inactivated.\n\nPlease proceed only if you are certain that you do not have any keys that are incorrectly marked inactive.\n\nAre you sure you want to proceed with deleting the inactive translations in the currently filtered list?"}
+  = link_to "Delete Inactive", delete_inactive_keys_translations_path(filters: params[:filters].to_unsafe_h), class: "btn btn-danger btn-sm space-left2", "data-method" => "delete", "data-confirm" => "Warning! This is a highly destructive action.\n\nIts possible to incorrectly upload an incomplete or incorrect file to 'Mark Inactive Translations from Source' which can leave you with inactive keys that maybe shouldnt have been inactivated.\n\nPlease proceed only if you are certain that you do not have any keys that are incorrectly marked inactive.\n\nAre you sure you want to proceed with deleting the inactive translations in the currently filtered list?"
 
 h2.page-title Translations
-- if params[:app_name]
+- if params[:app_name].present?
   h5.page-title App Name: #{params[:app_name]}
 
 br
 
 .well.well-sm
   .btn-group.pull-right.text-right
-    = link_to "Export to CSV", params.to_unsafe_h.merge(format: :csv), class: "btn btn-sm btn-success"
-    = link_to "YAML", params.to_unsafe_h.merge(format: :zip, export_format: :yaml), class: "btn btn-sm btn-success"
-    = link_to "JSON", params.to_unsafe_h.merge(format: :zip, export_format: :json), class: "btn btn-sm btn-success"
+    = link_to "Export to CSV", translations_path(format: :csv, app_name: params[:app_name]), class: "btn btn-sm btn-success"
+    = link_to "YAML", translations_path(format: :zip, export_format: :yaml, app_name: params[:app_name]), class: "btn btn-sm btn-success"
+    = link_to "JSON", translations_path(format: :zip, export_format: :json, app_name: params[:app_name]), class: "btn btn-sm btn-success"
 
   .pull-right.space-right2
 
@@ -25,7 +25,7 @@ table.table.table-striped.table-hover.space-above3.list-table
       th = sort_link(:app_name)
       th = sort_link(:key)
       th Default Translation
-      - if params[:status] == "Inactive"
+      - if params[:status] != "All Active Translations"
         th Status
       th = sort_link(:updated_at)
       th Actions
@@ -35,7 +35,7 @@ table.table.table-striped.table-hover.space-above3.list-table
         td = x.translation_app.name
         td = x.key
         td = x.default_translation
-        - if params[:status] == "Inactive"
+        - if params[:status] != "All Active Translations"
           td Inactive
         td = x.updated_at&.strftime("%Y-%m-%d %l:%M %p")
         td

data/lib/rails_i18n_manager/version.rb

@@ -1,3 +1,3 @@
 module RailsI18nManager
-  VERSION = "1.1.3".freeze
+  VERSION = "1.1.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_i18n_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails