decidim-term_customizer 0.17.0 → 0.20.0

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

@@ -2,7 +2,7 @@
   <div class="card-divider">
     <h2 class="card-title flex--sbc">
       <div>
-        <%= link_to t("decidim.term_customizer.menu.term_customizer"), root_path %>
+        <%= link_to t("decidim.term_customizer.menu.term_customizer"), translation_sets_path %>
         &gt;
         <%= link_to translated_attribute(set.name), translation_set_translations_path(set) %>
         &gt;

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

@@ -2,7 +2,7 @@
   <div class="card-divider">
     <h2 class="card-title flex--sbc">
       <div>
-        <%= link_to t("decidim.term_customizer.menu.term_customizer"), root_path %>
+        <%= link_to t("decidim.term_customizer.menu.term_customizer"), translation_sets_path %>
         &gt;
         <%= translated_attribute(set.name) %>
 
@@ -20,7 +20,7 @@
           <% if allowed_to? :import, :translation_set, translation_set: set %>
             <%= link_to t("actions.import", scope: "decidim.term_customizer.admin"), import_translation_set_translations_path(set), class: "button tiny button--simple" %>
           <% end %>
-          <% if allowed_to? :export, :translation_set, translation_set: set %>
+          <% if set.translations.count > 0 && allowed_to?(:export, :translation_set, translation_set: set) %>
             <%= render partial: "export_dropdown" %>
           <% end %>
         </div>

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

@@ -3,7 +3,7 @@
     <div class="card-divider">
       <h2 class="card-title flex--sbc">
         <div>
-          <%= link_to t("decidim.term_customizer.menu.term_customizer"), root_path %>
+          <%= link_to t("decidim.term_customizer.menu.term_customizer"), translation_sets_path %>
           &gt;
           <%= link_to translated_attribute(set.name), translation_set_translations_path(set) %>
           &gt;

data/app/views/decidim/term_customizer/admin/translations_destroys/new.html.erb

@@ -3,7 +3,7 @@
     <div class="card-divider">
       <h2 class="card-title flex--sbc">
         <div>
-          <%= link_to t("decidim.term_customizer.menu.term_customizer"), root_path %>
+          <%= link_to t("decidim.term_customizer.menu.term_customizer"), translation_sets_path %>
           &gt;
           <%= link_to translated_attribute(set.name), translation_set_translations_path(set) %>
           &gt;

data/config/locales/ca.yml

@@ -26,10 +26,13 @@ ca:
           back: Enrere
           cancel: Cancel
           clear_cache: Clear cache
+          confirm_duplicate: Are you sure you want to duplicate this set?
+          duplicate: Duplicate
           help: Help
           import: Import
           new_translation: Nova traducció
           new_translation_set: Nou set/joc de traducció
+          view: View
         add_translations:
           index:
             add: Afegir
@@ -61,6 +64,10 @@ ca:
             success: Traducció creada amb èxit
           destroy:
             success: La traducció ha estat esborrada amb èxit.
+          duplicate:
+            copied_set_name: Copy of %{name}
+            error: Error duplicating translation set.
+            success: Translation set successfully duplicated.
           edit:
             save: Guardar
             title: Set/Joc de traducció
@@ -70,7 +77,7 @@ ca:
             constraint_help_title: What are constraints?
             help_html: <p>A translation set is a "container" that holds the translations for a specific context you want to customize.</p> <p>Translation sets help you to organize your customizations and apply them to different contexts. This allows you to customize the same translation differently in different contexts.</p> <p>For example, if you want to customize a button with the term "Add" differently for different participatory processes, you can create separate translation sets for both processes and apply the set to those processes using the constraints.</p>
             help_title: What is a translation set?
-            title: Translation set.
+            title: Set/Joc de traducció
           index:
             no_records_html: <p>No translation sets available.</p> <p>Start by adding a translation set from the "<a href="%{new_set_link}">%{button_name}</a>" button.</p>
           new:

data/config/locales/en.yml

@@ -27,10 +27,13 @@ en:
           back: Back
           cancel: Cancel
           clear_cache: Clear cache
+          confirm_duplicate: Are you sure you want to duplicate this set?
+          duplicate: Duplicate
           help: Help
           import: Import
           new_translation: New translation
           new_translation_set: New translation set
+          view: View
         add_translations:
           index:
             add: Add
@@ -69,6 +72,10 @@ en:
             success: Translation set successfully created.
           destroy:
             success: Translation set successfully deleted.
+          duplicate:
+            copied_set_name: Copy of %{name}
+            error: Error duplicating translation set.
+            success: Translation set successfully duplicated.
           edit:
             save: Save
             title: Translation set
@@ -94,7 +101,7 @@ en:
               processes, you can create separate translation sets for both processes
               and apply the set to those processes using the constraints.</p>
             help_title: What is a translation set?
-            title: Translation set.
+            title: Translation set
           index:
             no_records_html: <p>No translation sets available.</p> <p>Start by adding
               a translation set from the "<a href="%{new_set_link}">%{button_name}</a>"

data/config/locales/es.yml

@@ -26,10 +26,13 @@ es:
           back: Volver
           cancel: Cancel
           clear_cache: Clear cache
+          confirm_duplicate: Are you sure you want to duplicate this set?
+          duplicate: Duplicate
           help: Help
           import: Import
           new_translation: Nueva traducción
           new_translation_set: Nuevo grupo de traducciones
+          view: View
         add_translations:
           index:
             add: Añadir
@@ -61,6 +64,10 @@ es:
             success: Gurpo de tranducciones creado exitosamente.
           destroy:
             success: El grupo de traducciones ha sido creado exitosamente.
+          duplicate:
+            copied_set_name: Copy of %{name}
+            error: Error duplicating translation set.
+            success: Translation set successfully duplicated.
           edit:
             save: Guardar
             title: Grupo de traducciones
@@ -70,7 +77,7 @@ es:
             constraint_help_title: What are constraints?
             help_html: <p>A translation set is a "container" that holds the translations for a specific context you want to customize.</p> <p>Translation sets help you to organize your customizations and apply them to different contexts. This allows you to customize the same translation differently in different contexts.</p> <p>For example, if you want to customize a button with the term "Add" differently for different participatory processes, you can create separate translation sets for both processes and apply the set to those processes using the constraints.</p>
             help_title: What is a translation set?
-            title: Translation set.
+            title: Grupo de traducciones
           index:
             no_records_html: <p>No translation sets available.</p> <p>Start by adding a translation set from the "<a href="%{new_set_link}">%{button_name}</a>" button.</p>
           new:

data/config/locales/fi.yml

@@ -26,10 +26,13 @@ fi:
           back: Takaisin
           cancel: Peruuta
           clear_cache: Tyhjennä välimuisti
+          confirm_duplicate: Haluatko varmasti kopioida tämän paketin?
+          duplicate: Kopioi
           help: Ohjeet
           import: Tuo
           new_translation: Uusi käännös
           new_translation_set: Uusi käännöspaketti
+          view: Näytä
         add_translations:
           index:
             add: Lisää
@@ -61,6 +64,10 @@ fi:
             success: Käännöspaketin luonti onnistui.
           destroy:
             success: Käännöspaketin poisto onnistui.
+          duplicate:
+            copied_set_name: 'Kopio: %{name}'
+            error: Käännöspaketin kopiointi epäonnistui.
+            success: Käännöspaketin kopiointi onnistui.
           edit:
             save: Tallenna
             title: Käännöspaketti
@@ -70,7 +77,7 @@ fi:
             constraint_help_title: Mitä ovat rajaussäännöt?
             help_html: <p>Käännöspaketti, on "paketti", joka sisältää käännöksiä tietylle kontekstille, jonka termejä haluat muuttaa.</p><p>Käännöspaketit auttavat sinua pitämään kustomointisi järjestyksessä ja rajaamaan niitä tiettyihin konteksteihin. Tämä mahdollistaa sen, että voit esimerkiksi muuttaa saman termin eri tavalla sivuston eri paikoissa.</p><p>Mikäli haluat esimerkiski muuttaa "Lisää" -napin tekstin erilaiseksi eri prosesseille, voit luoda kaksi erillistä käännöspakettia molempia prosesseja varten. Molemmat paketit rajataan kyseisiin prosesseihin rajaussääntöjen avulla.</p>
             help_title: Mikä on käännöspaketti?
-            title: Käännöspaketti.
+            title: Käännöspaketti
           index:
             no_records_html: <p>Ei käännöspaketteja.</p><p>Aloita lisäämällä käännöspaketti "<a href="%{new_set_link}">%{button_name}</a>" -napin avulla.</p>
           new:

data/config/locales/fr.yml

@@ -26,10 +26,13 @@ fr:
           back: Retour
           cancel: Cancel
           clear_cache: Purger le cache
+          confirm_duplicate: Are you sure you want to duplicate this set?
+          duplicate: Duplicate
           help: Help
           import: Import
           new_translation: Nouvelle traduction
           new_translation_set: Nouveau jeu de traduction
+          view: View
         add_translations:
           index:
             add: Ajouter
@@ -61,16 +64,20 @@ fr:
             success: Jeu de traduction créé avec succès.
           destroy:
             success: Le jeu de traduction a été supprimé.
+          duplicate:
+            copied_set_name: Copy of %{name}
+            error: Error duplicating translation set.
+            success: Translation set successfully duplicated.
           edit:
             save: Sauvegarder
-            title: Jeu de traduction
+            title: Jeu de traductions
           form:
             add_constraint: Ajouter contrainte
             constraint_help_html: <p>Constraints are specific rules that allow you to apply the customizations in a set to a specific context.</p> <p>In case you do not define any constraint rules, the customizations in this set will apply to the whole application. On the other hand, if you want the customizations in this set to apply only to a specific process, select "Participatory processes" as the participatory space type and the target process as the participatory space. Furthermore, you can also apply the customizations to a specific component by defining the component for the constraint.</p> <p>If you define multiple constraints, the customizations will apply in all of those.</p>
             constraint_help_title: What are constraints?
             help_html: <p>A translation set is a "container" that holds the translations for a specific context you want to customize.</p> <p>Translation sets help you to organize your customizations and apply them to different contexts. This allows you to customize the same translation differently in different contexts.</p> <p>For example, if you want to customize a button with the term "Add" differently for different participatory processes, you can create separate translation sets for both processes and apply the set to those processes using the constraints.</p>
             help_title: What is a translation set?
-            title: Translation set.
+            title: Jeu de traductions
           index:
             no_records_html: <p>No translation sets available.</p> <p>Start by adding a translation set from the "<a href="%{new_set_link}">%{button_name}</a>" button.</p>
           new:

data/config/locales/sv.yml

@@ -26,10 +26,13 @@ sv:
           back: Back
           cancel: Cancel
           clear_cache: Clear cache
+          confirm_duplicate: Are you sure you want to duplicate this set?
+          duplicate: Duplicate
           help: Help
           import: Import
           new_translation: New translation
           new_translation_set: New translation set
+          view: View
         add_translations:
           index:
             add: Add
@@ -61,6 +64,10 @@ sv:
             success: Translation set successfully created.
           destroy:
             success: Translation set successfully deleted.
+          duplicate:
+            copied_set_name: Copy of %{name}
+            error: Error duplicating translation set.
+            success: Translation set successfully duplicated.
           edit:
             save: Save
             title: Translation set
@@ -70,7 +77,7 @@ sv:
             constraint_help_title: What are constraints?
             help_html: <p>A translation set is a "container" that holds the translations for a specific context you want to customize.</p> <p>Translation sets help you to organize your customizations and apply them to different contexts. This allows you to customize the same translation differently in different contexts.</p> <p>For example, if you want to customize a button with the term "Add" differently for different participatory processes, you can create separate translation sets for both processes and apply the set to those processes using the constraints.</p>
             help_title: What is a translation set?
-            title: Translation set.
+            title: Translation set
           index:
             no_records_html: <p>No translation sets available.</p> <p>Start by adding a translation set from the "<a href="%{new_set_link}">%{button_name}</a>" button.</p>
           new:

data/lib/decidim/term_customizer.rb

@@ -4,12 +4,17 @@ require_relative "term_customizer/version"
 require_relative "term_customizer/engine"
 require_relative "term_customizer/admin"
 require_relative "term_customizer/admin_engine"
+require_relative "term_customizer/context"
 
 module Decidim
   module TermCustomizer
+    include ActiveSupport::Configurable
+
     autoload :I18nBackend, "decidim/term_customizer/i18n_backend"
     autoload :Import, "decidim/term_customizer/import"
     autoload :Loader, "decidim/term_customizer/loader"
+    autoload :PluralFormsForm, "decidim/term_customizer/plural_forms_form"
+    autoload :PluralFormsManager, "decidim/term_customizer/plural_forms_manager"
     autoload :Resolver, "decidim/term_customizer/resolver"
     autoload :TranslationDirectory, "decidim/term_customizer/translation_directory"
     autoload :TranslationImportCollection, "decidim/term_customizer/translation_import_collection"
@@ -19,6 +24,18 @@ module Decidim
 
     EMPTY_HASH = {}.freeze
 
+    # In case you want to customize the context detection for the controllers
+    # and views, configure your own context resolver.
+    config_accessor :controller_context_class do
+      Decidim::TermCustomizer::Context::ControllerContext
+    end
+
+    # In case you want to customize the context detection for the jobs,
+    # configure your own context resolver.
+    config_accessor :job_context_class do
+      Decidim::TermCustomizer::Context::JobContext
+    end
+
     class << self
       attr_accessor :loader
     end

data/lib/decidim/term_customizer/admin_engine.rb

@@ -11,11 +11,12 @@ module Decidim
       routes do
         resources :translation_sets, path: :sets, except: [:show] do
           member do
-            post :export
+            post :duplicate
           end
 
           resources :translations, except: [:show] do
             collection do
+              post :export
               get :import, action: :new_import
               post :import
               resource :translations_destroy, only: [:new, :destroy]

data/lib/decidim/term_customizer/context.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Context
+      autoload :Base, "decidim/term_customizer/context/base"
+      autoload :ControllerContext, "decidim/term_customizer/context/controller_context"
+      autoload :JobContext, "decidim/term_customizer/context/job_context"
+    end
+  end
+end

data/lib/decidim/term_customizer/context/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Context
+      # A context object resolves and stores the translation context for
+      # different application contexts. Contexts can be e.g.
+      # - Controller context, which is used to display translations in
+      #   controller messages and the views.
+      # - Job context, which is used to display messages within jobs, mainly
+      #   when sending emails.
+      #
+      # The initialization method gets the data for the context which is used
+      # to resolve the translation context objects (organization, participatory
+      # space and component). These are then used to load the correct
+      # translations for each context based on the translation set constraints.
+      class Base
+        attr_reader :organization, :space, :component
+
+        def initialize(data)
+          @data = data
+
+          # Implement the resolve! method in the sub-classes
+          resolve!
+        end
+
+        protected
+
+        attr_reader :data
+      end
+    end
+  end
+end

data/lib/decidim/term_customizer/context/controller_context.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Context
+      class ControllerContext < Base
+        def resolve!
+          env = data[:headers].env
+          controller = env["action_controller.instance"]
+
+          @organization = env["decidim.current_organization"]
+
+          # 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. In some edge cases this may not
+          # be implemented (https://github.com/mainio/decidim-module-term_customizer/issues/28)
+          # in which case we do not have access to the participatory space.
+          if controller.respond_to?(:current_participatory_space, true)
+            @space = controller.send(
+              :current_participatory_space
+            )
+          end
+          @space ||= env["decidim.current_participatory_space"]
+
+          @component = env["decidim.current_component"]
+        end
+      end
+    end
+  end
+end

data/lib/decidim/term_customizer/context/job_context.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Context
+      class JobContext < Base
+        def resolve!
+          # Figure out the organization and user through the job arguments if
+          # passed for the job.
+          user = nil
+          data[:job].arguments.each do |arg|
+            @organization ||= organization_from_argument(arg)
+            @space ||= space_from_argument(arg)
+            @component ||= component_from_argument(arg)
+            user ||= arg if arg.is_a?(Decidim::User)
+          end
+
+          # In case a component was found, define the space as the component
+          # space to avoid any conflicts.
+          @space = component.participatory_space if component
+
+          # In case a space was found, define the organization as the space
+          # organization to avoid any conflicts.
+          @organization = space.organization if space
+
+          # In case an organization could not be resolved any other way, check
+          # it through the user (if the user was passed).
+          @organization ||= user.organization if user
+        end
+
+        protected
+
+        def organization_from_argument(arg)
+          return arg if arg.is_a?(Decidim::Organization)
+
+          arg.organization if arg.respond_to?(:organization)
+        end
+
+        def space_from_argument(arg)
+          return arg if arg.is_a?(Decidim::Participable)
+
+          arg.participatory_space if arg.respond_to?(:participatory_space)
+        end
+
+        def component_from_argument(arg)
+          return arg if arg.is_a?(Decidim::Component)
+
+          arg.component if arg.respond_to?(:component)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/term_customizer/engine.rb

@@ -17,25 +17,13 @@ module Decidim
         # done through a notification to get access to the `current_*`
         # 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
+          context = TermCustomizer.controller_context_class.new(data)
 
           # Create a new resolver instance within the current request scope
           resolver = Resolver.new(
-            env["decidim.current_organization"],
-            space,
-            env["decidim.current_component"]
+            context.organization,
+            context.space,
+            context.component
           )
 
           # Create the loader for the backend to fetch the translations from
@@ -58,22 +46,15 @@ module Decidim
         # 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
+          context = TermCustomizer.job_context_class.new(data)
 
           # Create resolver for the target organization or global context in
           # case organization was not found
-          resolver = Resolver.new(organization, nil, nil)
+          resolver = Resolver.new(
+            context.organization,
+            context.space,
+            context.component
+          )
 
           # Create the loader for the backend to fetch the translations from
           TermCustomizer.loader = Loader.new(resolver)