decidim-term_customizer 0.16.3 → 0.16.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1966c6d76f52620be03f12e047aaae93afeb95fe0514dc4710d89a6f3bfdfd
-  data.tar.gz: 325607f77cf3ac7760e86ca9a8d29a16dcedfcfcc2b3cb971eb4ab048f49211a
+  metadata.gz: b9473c65d949ac1f1c14f152bad4cd0c04ffcff5f2a9ad377dc470f2af4fc256
+  data.tar.gz: 64b870998a9239a6242ea2bd1ebe0ac1e00b1bcb9812d7b5bd3efa2618dbbb68
 SHA512:
-  metadata.gz: b8020b5e16df220bf10b4daf420a05ae5547eb79eb3a5473b4cb9c1200d6ac5ec6ecd71a85000463459a9abc6057226d9a019c77225956fec165971e546e73a1
-  data.tar.gz: fb719d2024b32369669f7c62c7aa9b7960d57e79d812299e7498e9b08308767e10f087077dcfdea14eb9b3f4a5b5c5f05df0d28e5b7cd74a71e97767b3d20e0f
+  metadata.gz: '08f642fc149b9d8664081607afe9fb167fcc42dc7f6e2f02a8b73c0a0efd746f2c015e0023d46b5e6d4241e342bb13dbf7a2e2087508c850060a44378435933f'
+  data.tar.gz: c6648b9f8d3e89a7308d4b320a4bf96b6e09fa5d958a5005b343832534eae8c827d8171fa7a9f0bb669d9f6c350dcdb46bfc5b92986b39e3610ae0491d3ad944

data/app/commands/decidim/term_customizer/admin/import_translation_keys.rb

@@ -38,20 +38,19 @@ module Decidim
         attr_reader :form
 
         def create_translations
-          form.keys.each do |key|
-            form.current_organization.available_locales.each do |locale|
+          items = form.keys.map do |key|
+            form.current_organization.available_locales.map do |locale|
               attrs = {
-                translation_set: form.translation_set,
                 key: key,
                 locale: locale
               }
               next unless TermCustomizer::Translation.find_by(attrs).nil?
 
-              TermCustomizer::Translation.create!(
-                attrs.merge(value: I18n.t(key, locale: locale, default: ""))
-              )
+              attrs.merge(value: I18n.t(key, locale: locale, default: ""))
             end
           end.flatten
+
+          form.translation_set.translations.create!(items)
         end
       end
     end

data/app/controllers/decidim/term_customizer/admin/caches_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class CachesController < TermCustomizer::Admin::ApplicationController
+        def index
+          enforce_permission_to :update, :organization
+
+          redirect_to translation_sets_path
+        end
+
+        def clear
+          enforce_permission_to :update, :organization
+
+          TermCustomizer.loader.clear_cache
+          flash[:notice] = I18n.t("caches.clear.success", scope: "decidim.term_customizer.admin")
+
+          redirect_to translation_sets_path
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/term_customizer/admin/translations_controller.rb

@@ -88,7 +88,10 @@ module Decidim
         end
 
         def translations
-          @translations ||= SetTranslations.new(translation_set, current_locale)
+          @translations ||= SetTranslations.new(
+            translation_set,
+            current_locale
+          ).query.page(params[:page]).per(30)
         end
 
         def translation

data/app/views/decidim/term_customizer/admin/translation_sets/index.html.erb

@@ -1,10 +1,20 @@
 <div class="card" id="translation_sets">
   <div class="card-divider">
-    <h2 class="card-title">
-      <%= t "decidim.admin.titles.translation_sets" %>
-      <% if allowed_to? :create, :translation_set %>
-        <%= link_to t("actions.new_translation_set", scope: "decidim.admin"), new_translation_set_path, class: "button tiny button--title" %>
-      <% end %>
+    <h2 class="card-title flex--sbc">
+      <div>
+        <%= t "decidim.admin.titles.translation_sets" %>
+      </div>
+
+      <div class="flex--cc flex-gap--1">
+        <div id="js-other-actions-wrapper">
+          <% if allowed_to? :create, :translation_set %>
+            <%= link_to t("actions.new_translation_set", scope: "decidim.admin"), new_translation_set_path, class: "button tiny button--simple" %>
+          <% end %>
+          <% if allowed_to? :update, :organization %>
+            <%= link_to t("actions.clear_cache", scope: "decidim.admin"), clear_caches_path, method: :delete, class: "button tiny button--simple", data: { confirm: t("actions.confirm_destroy", scope: "decidim.admin") } %>
+          <% end %>
+        </div>
+      </div>
     </h2>
   </div>
   <div class="card-section">

data/app/views/decidim/term_customizer/admin/translations/index.html.erb

@@ -51,6 +51,7 @@
           <% end %>
         </tbody>
       </table>
+      <%= paginate @translations, theme: "decidim" %>
     </div>
   </div>
 </div>

data/config/locales/ca.yml

@@ -15,6 +15,7 @@ ca:
       actions:
         add_multiple_translations: Afegir múltiples
         back: Enrere
+        clear_cache: Clear cache
         new_translation_set: Nou set/joc de traducció
         new_translation: Nova traducció
       models:
@@ -35,6 +36,9 @@ ca:
           index:
             add: Afegir
             search: Buscar
+        caches:
+          clear:
+            success: Cache cleared successfully
         translation_sets:
           constraint_fields:
             constraint: Obligatori

data/config/locales/en.yml

@@ -15,6 +15,7 @@ en:
       actions:
         add_multiple_translations: Add multiple
         back: Back
+        clear_cache: Clear cache
         new_translation_set: New translation set
         new_translation: New translation
       models:
@@ -35,6 +36,9 @@ en:
           index:
             add: Add
             search: Search
+        caches:
+          clear:
+            success: Cache cleared successfully
         translation_sets:
           constraint_fields:
             constraint: Constraint

data/config/locales/es.yml

@@ -15,6 +15,7 @@ es:
       actions:
         add_multiple_translations: Agregar varios
         back: Volver
+        clear_cache: Clear cache
         new_translation_set: Nuevo grupo de traducciones
         new_translation: Nueva traducción
       models:
@@ -35,6 +36,9 @@ es:
           index:
             add: Añadir
             search: Buscar
+        caches:
+          clear:
+            success: Cache cleared successfully
         translation_sets:
           constraint_fields:
             constraint: Ámbito

data/config/locales/fi.yml

@@ -15,6 +15,7 @@ fi:
       actions:
         add_multiple_translations: Lisää useita
         back: Takaisin
+        clear_cache: Tyhjennä välimuisti
         new_translation_set: Uusi käännöspaketti
         new_translation: Uusi käännös
       models:
@@ -35,6 +36,9 @@ fi:
           index:
             add: Lisää
             search: Hae
+        caches:
+          clear:
+            success: Välimuistin tyhjennys onnistui
         translation_sets:
           constraint_fields:
             constraint: Rajaussääntö

data/config/locales/sv.yml

@@ -15,6 +15,7 @@ sv:
       actions:
         add_multiple_translations: Add multiple
         back: Back
+        clear_cache: Clear cache
         new_translation_set: New translation set
         new_translation: New translation
       models:
@@ -35,6 +36,9 @@ sv:
           index:
             add: Add
             search: Search
+        caches:
+          clear:
+            success: Cache cleared successfully
         translation_sets:
           constraint_fields:
             constraint: Constraint

data/lib/decidim/term_customizer/admin_engine.rb

@@ -18,6 +18,12 @@ module Decidim
           end
         end
 
+        resources :caches, only: [:index] do
+          collection do
+            delete :clear
+          end
+        end
+
         root to: "translation_sets#index"
       end
 

data/lib/decidim/term_customizer/engine.rb

@@ -18,17 +18,69 @@ module Decidim
         # environment variables within Decidim.
         ActiveSupport::Notifications.subscribe "start_processing.action_controller" do |_name, _started, _finished, _unique_id, data|
           env = data[:headers].env
+          controller = data[:headers].env["action_controller.instance"]
+
+          # E.g. at the participatory process controller the
+          # `decidim.current_participatory_space` environment variable has not
+          # been set. Therefore, we need to fetch it directly from the
+          # controller using its private method.
+          space =
+            if controller.respond_to?(:current_participatory_space, true)
+              controller.send(:current_participatory_space)
+            else
+              env["decidim.current_participatory_space"]
+            end
 
           # Create a new resolver instance within the current request scope
-          TermCustomizer.resolver = Resolver.new(
+          resolver = Resolver.new(
             env["decidim.current_organization"],
-            env["decidim.current_participatory_space"],
+            space,
             env["decidim.current_component"]
           )
 
+          # Create the loader for the backend to fetch the translations from
+          TermCustomizer.loader = Loader.new(resolver)
+
           # Force the backend to reload the translations for the current request
           customizer_backend.reload!
         end
+
+        # The jobs are generally run in different context than the controllers
+        # which causes the term customizations not to be active. During the
+        # jobs, only the organization and global context translations are loaded
+        # because otherwise this would have to be job specific.
+        #
+        # Currently this has been only tested against the event notification
+        # jobs but it may work for other jobs as well. Because the jobs
+        # themselves don't carry any other context information than their
+        # arguments, it is difficult to resolve their correct context. Note also
+        # that e.g. the email notifications are always created through a single
+        # job that may be fired by another job (i.e. the notification job is
+        # always performed last).
+        ActiveSupport::Notifications.subscribe "perform_start.active_job" do |_name, _started, _finished, _unique_id, data|
+          # Figure out the organization and user through the job arguments if
+          # passed for the job.
+          organization = nil
+          user = nil
+          data[:job].arguments.each do |arg|
+            organization = arg if arg.is_a?(Decidim::Organization)
+            user = arg if arg.is_a?(Decidim::User)
+          end
+
+          # In case an organization was not passed for the job, check it through
+          # the user.
+          organization = user.organization if organization.nil? && user
+
+          # Create resolver for the target organization or global context in
+          # case organization was not found
+          resolver = Resolver.new(organization, nil, nil)
+
+          # Create the loader for the backend to fetch the translations from
+          TermCustomizer.loader = Loader.new(resolver)
+
+          # Force the backend to reload the translations for the job
+          customizer_backend.reload!
+        end
       end
     end
   end

data/lib/decidim/term_customizer/i18n_backend.rb

@@ -32,24 +32,9 @@ module Decidim
 
         def translations
           return @translations if @translations
-          return {} unless TermCustomizer.resolver
+          return {} unless TermCustomizer.loader
 
-          @translations = {}
-
-          TermCustomizer.resolver.translations.each do |tr|
-            keyparts = [tr.locale] + tr.key.split(".")
-            lastkey = keyparts.pop.to_sym
-
-            current = @translations
-            keyparts.each do |key|
-              current[key.to_sym] ||= {}
-              current = current[key.to_sym]
-            end
-
-            current[lastkey] = tr.value
-          end
-
-          @translations
+          @translations = TermCustomizer.loader.translations_hash
         end
 
         protected

data/lib/decidim/term_customizer/loader.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    # The loader class is a middleman that converts the Translation model
+    # objects to a flat translation hash that can be directly used in the i18n
+    # backend. The main purpose of this class is to add caching possibility for
+    # the translation hashes.
+    class Loader
+      def initialize(resolver)
+        @resolver = resolver
+      end
+
+      # Converts the translation objects to a flat hash where the keys are
+      # the translatable keys used in the i18n backend containing the locales.
+      # The values of the hash are the translations for the keys.
+      #
+      # The final hash looks similar like this:
+      # {
+      #   en: {
+      #     decidim: {
+      #       translation: "Term EN"
+      #     }
+      #   },
+      #   fi: {
+      #     decidim: {
+      #       translation: "Term FI"
+      #     }
+      #   }
+      # }
+      #
+      # This will also cache the results and fetch the result directly from
+      # cache on consequent calls until the cache is expired.
+      def translations_hash
+        @translations_hash ||= Rails.cache.fetch(
+          cache_key,
+          expires_in: 24.hours
+        ) do
+          final_hash = {}
+          resolver.translations.each do |tr|
+            keyparts = [tr.locale] + tr.key.split(".")
+            lastkey = keyparts.pop.to_sym
+
+            current = final_hash
+            keyparts.each do |key|
+              current[key.to_sym] ||= {}
+              current = current[key.to_sym]
+            end
+
+            current[lastkey] = tr.value
+          end
+          final_hash
+        end
+      end
+
+      # Clears the translations cache only for the current context defined by
+      # the resolver.
+      def clear_cache
+        Rails.cache.delete_matched("#{cache_key_base}/*")
+      end
+
+      private
+
+      attr_reader :resolver
+
+      def cache_key
+        parts = [cache_key_base]
+        parts << "space_#{resolver.space.id}" if resolver.space
+        parts << "component_#{resolver.component.id}" if resolver.component
+
+        parts.join("/")
+      end
+
+      def cache_key_base
+        main_key =
+          if resolver.organization
+            "organization_#{resolver.organization.id}"
+          else
+            "system"
+          end
+
+        "decidim_term_customizer/#{main_key}"
+      end
+    end
+  end
+end

data/lib/decidim/term_customizer/resolver.rb

@@ -3,6 +3,8 @@
 module Decidim
   module TermCustomizer
     class Resolver
+      attr_reader :organization, :space, :component
+
       def initialize(organization, space, component)
         @organization = organization
         @space = space
@@ -19,8 +21,6 @@ module Decidim
 
       private
 
-      attr_reader :organization, :space, :component
-
       def resolve_translations_query
         query = translations_base_query
         translations_add_constraints_query(query)

data/lib/decidim/term_customizer/version.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   module TermCustomizer
-    VERSION = "0.16.3"
+    VERSION = "0.16.5"
     DECIDIM_VERSION = "~> 0.16.0"
   end
 end

data/lib/decidim/term_customizer.rb

@@ -8,6 +8,7 @@ require_relative "term_customizer/admin_engine"
 module Decidim
   module TermCustomizer
     autoload :I18nBackend, "decidim/term_customizer/i18n_backend"
+    autoload :Loader, "decidim/term_customizer/loader"
     autoload :Resolver, "decidim/term_customizer/resolver"
     autoload :TranslationDirectory, "decidim/term_customizer/translation_directory"
     autoload :TranslationStore, "decidim/term_customizer/translation_store"
@@ -15,7 +16,7 @@ module Decidim
     EMPTY_HASH = {}.freeze
 
     class << self
-      attr_accessor :resolver
+      attr_accessor :loader
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-term_customizer
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.16.5
 platform: ruby
 authors:
 - Antti Hukkanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -118,6 +118,7 @@ files:
 - app/commands/decidim/term_customizer/admin/update_translation_set.rb
 - app/controllers/decidim/term_customizer/admin/add_translations_controller.rb
 - app/controllers/decidim/term_customizer/admin/application_controller.rb
+- app/controllers/decidim/term_customizer/admin/caches_controller.rb
 - app/controllers/decidim/term_customizer/admin/translation_sets_controller.rb
 - app/controllers/decidim/term_customizer/admin/translations_controller.rb
 - app/forms/decidim/term_customizer/admin/translation_form.rb
@@ -157,6 +158,7 @@ files:
 - lib/decidim/term_customizer/admin_engine.rb
 - lib/decidim/term_customizer/engine.rb
 - lib/decidim/term_customizer/i18n_backend.rb
+- lib/decidim/term_customizer/loader.rb
 - lib/decidim/term_customizer/resolver.rb
 - lib/decidim/term_customizer/test/factories.rb
 - lib/decidim/term_customizer/translation_directory.rb