decidim-term_customizer 0.16.6 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0adf060c3c243ebc5ac49b06b470a5ca036d6fe04ecee991775e5da5d464a65
-  data.tar.gz: eb46370b1bf5186def7e3aa10b7b93c50ac5704f858b665fe4dffb62de877261
+  metadata.gz: 16eec8f526df47ea82ef79a644e4afd290f64e7e1f7aa2fea64723ad7a30d6b9
+  data.tar.gz: 93c4464c8c3e2b3437df94b25e0f457e60ad1f18240c1fbc6609421600888805
 SHA512:
-  metadata.gz: 42bff42d6fe263926813ed5f3e56822be28d4a483784d8097572a891e9a86152ff3ae3e432f4475fab443bb4a01f6ac65d6ae33d5474f155cbc3f095604c9ea6
-  data.tar.gz: 8e8c1cee2e2350183ee9bbf5e6f3f185f56eb5a720742526c3acd367ad10bf7d7bcfe5aa437c3aadad9d32e70cbb4ced5712cefdf00eccba68327cf988002f66
+  metadata.gz: 4efdea5c3cca3ec8cd9f1e4d068b63f587b84f1ec9c175f9be2d1ff5832b688c467655596fcc85be7d2c2d6f22acffcf3c07913910c6a74151a4b5e4bb35aff6
+  data.tar.gz: 8864a676c3562377cc114556c058cbe50983d4b4691f9007130de45d3addbc8bb0ab4dd670c11e2a1412e53b748f06a06b78d23f652b379808ee499be24ce99c

data/app/assets/javascripts/decidim/term_customizer/admin/translations_admin_bulk.js.es6

@@ -0,0 +1,113 @@
+// = require_self
+
+/* eslint-disable no-invalid-this */
+$(document).ready(function () {
+  let selectedTranslationsCount = function() {
+    return $(".table-list .js-check-all-translation:checked").length
+  }
+
+  window.selectedTranslationsCountUpdate = function() {
+    if (selectedTranslationsCount() === 0) {
+      $("#js-selected-translation-count").text("")
+    } else {
+      $("#js-selected-translation-count").text(selectedTranslationsCount());
+    }
+  }
+
+  let showBulkActionsButton = function() {
+    if (selectedTranslationsCount() > 0) {
+      $("#js-bulk-actions-button").removeClass("hide");
+    }
+  }
+
+  let hideBulkActionsButton = function(force = false) {
+    if (selectedTranslationsCount() === 0 || force === true) {
+      $("#js-bulk-actions-button").addClass("hide");
+      $("#js-bulk-actions-dropdown").removeClass("is-open");
+    }
+  }
+
+  window.showOtherActionsButtons = function() {
+    $("#js-other-actions-wrapper").removeClass("hide");
+  }
+
+  const hideOtherActionsButtons = function() {
+    $("#js-other-actions-wrapper").addClass("hide");
+  }
+
+  window.hideBulkActionForms = function() {
+    return $(".js-bulk-action-form").addClass("hide");
+  }
+
+  if ($(".js-bulk-action-form").length) {
+    window.hideBulkActionForms();
+    $("#js-bulk-actions-button").addClass("hide");
+
+    $("#js-bulk-actions-dropdown ul li button").click(function(ev) {
+      ev.preventDefault();
+      let action = $(ev.target).data("action");
+
+      if (action) {
+        $(`#js-form-${action}`).submit(function() {
+          $(".layout-content > .callout-wrapper").html("");
+        })
+
+        $(`#js-${action}-actions`).removeClass("hide");
+        hideBulkActionsButton(true);
+        hideOtherActionsButtons();
+      }
+    })
+
+    // select all checkboxes
+    $(".js-check-all").change(function() {
+      $(".js-check-all-translation").prop("checked", $(this).prop("checked"));
+
+      if ($(this).prop("checked")) {
+        $(".js-check-all-translation").closest("tr").addClass("selected");
+        showBulkActionsButton();
+      } else {
+        $(".js-check-all-translation").closest("tr").removeClass("selected");
+        hideBulkActionsButton();
+      }
+
+      window.selectedTranslationsCountUpdate();
+    });
+
+    // translation checkbox change
+    $(".table-list").on("change", ".js-check-all-translation", function () {
+      let translationId = $(this).val()
+      let checked = $(this).prop("checked")
+
+      // uncheck "select all", if one of the listed checkbox item is unchecked
+      if ($(this).prop("checked") === false) {
+        $(".js-check-all").prop("checked", false);
+      }
+      // check "select all" if all checkbox translations are checked
+      if ($(".js-check-all-translation:checked").length === $(".js-check-all-translation").length) {
+        $(".js-check-all").prop("checked", true);
+        showBulkActionsButton();
+      }
+
+      if ($(this).prop("checked")) {
+        showBulkActionsButton();
+        $(this).closest("tr").addClass("selected");
+      } else {
+        hideBulkActionsButton();
+        $(this).closest("tr").removeClass("selected");
+      }
+
+      if ($(".js-check-all-translation:checked").length === 0) {
+        hideBulkActionsButton();
+      }
+
+      $(".js-bulk-action-form").find(`.js-translation-id-${translationId}`).prop("checked", checked);
+      window.selectedTranslationCountUpdate();
+    });
+
+    $(".js-cancel-bulk-action").on("click", function () {
+      window.hideBulkActionForms()
+      showBulkActionsButton();
+      window.showOtherActionsButtons();
+    });
+  }
+});

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      # A command with all the business logic when an admin destroys
+      # translations from a translation set.
+      class DestroyTranslations < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless form.valid?
+
+          destroy_translations
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form
+
+        def destroy_translations
+          form.translations.destroy_all
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "zip"
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      # A command with all the business logic when importing translations to a
+      # set from a file submitted through the form. The file may be one of the
+      # supported import formats or a ZIP file containing a supported import
+      # file.
+      class ImportSetTranslations < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form            - A form object with the params.
+        # translation_set - The translation set to which the import is
+        #                   performed.
+        def initialize(form, translation_set)
+          @form = form
+          @translation_set = translation_set
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          @translations = import_translations
+
+          if @translations.length.positive?
+            broadcast(:ok, @translations)
+          else
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :translation_set
+
+        # Private: Handles the import of either a zip file or a regular import
+        # file, one of the supported reader formats based on the file provided
+        # by the import form.
+        #
+        # Returns Array or nil. The returned value is an array of the imported
+        # translations when the import is successful, otherwise nil.
+        def import_translations
+          return import_zip(form.file_path) if form.zip_file?
+
+          import_file(form.file_path, form.mime_type)
+        end
+
+        # Private: Handles the import of a regular import file, one of the
+        # supported reader formats. Will iterate over the whole imported data
+        # array and save all records to the database.
+        #
+        # filepath  - A filepath with the data to be imported.
+        # mime_type - The mime type of the provided file.
+        #
+        # Returns Array or nil. The returned value is an array of the imported
+        # translations when the import is successful, otherwise nil.
+        def import_file(filepath, mime_type)
+          importer_for(filepath, mime_type).import do |records|
+            import = TranslationImportCollection.new(
+              translation_set,
+              records,
+              form.current_organization.available_locales
+            )
+
+            return translation_set.translations.create(import.import_attributes)
+          end
+
+          nil
+        end
+
+        # Private: Parses through the provided zip file and searches for the
+        # first file with one of the supported import formats. Once found,
+        # creates an extracted temp file of that file and passes that back to
+        # the import method for the final import to be executed on.
+        #
+        # If no supported import file is found at the root of the zip archive,
+        # nothing will be done and false will be returned.
+        #
+        # filepath - A filepath with the zip file containing the actual import
+        #            file.
+        #
+        # Returns Array or nil. The returned value is an array of the imported
+        # translations when the import is successful, otherwise nil.
+        def import_zip(filepath)
+          Zip::File.open(filepath) do |zip_file|
+            zip_file.each do |entry|
+              next unless entry.file?
+
+              ext = File.extname(entry.name)[1..-1]
+              mime_type = TranslationsImportForm::ACCEPTED_MIME_TYPES[ext.to_sym]
+              next if mime_type.nil?
+
+              collection = nil
+
+              file = Tempfile.new("translations_import.#{ext}")
+              begin
+                content = entry.get_input_stream.read.force_encoding("UTF-8")
+                file.write(content)
+                file.close
+
+                collection = import_file(file.path, mime_type)
+              ensure
+                file.unlink
+              end
+
+              return collection
+            end
+          end
+
+          nil
+        end
+
+        # Private: Creates a new imported for the provided file with the given
+        # mime type.
+        #
+        # filepath  - A filepath with the data to be imported.
+        # mime_type - The mime type of the provided file.
+        #
+        # Returns Decidim::TermCustomizer::Import::Importer.
+        def importer_for(filepath, mime_type)
+          Import::ImporterFactory.build(
+            filepath,
+            mime_type,
+            TranslationParser
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -75,6 +75,17 @@ module Decidim
           redirect_to translation_sets_path
         end
 
+        def export
+          enforce_permission_to :export, :translation_set, translation_set: set
+          name = "set-translations"
+
+          ExportJob.perform_later(current_user, set, name, params[:format] || "json")
+
+          flash[:notice] = I18n.t("exports.notice", scope: "decidim.admin")
+
+          redirect_to translation_set_translations_path(set)
+        end
+
         private
 
         def sets

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

@@ -79,6 +79,29 @@ module Decidim
           redirect_to translation_set_translations_path(set)
         end
 
+        def new_import
+          enforce_permission_to :import, :translation_set, translation_set: set
+
+          @import = form(Admin::TranslationsImportForm).instance
+        end
+
+        def import
+          enforce_permission_to :import, :translation_set, translation_set: set
+
+          @import = form(Admin::TranslationsImportForm).from_params(params)
+          ImportSetTranslations.call(@import, set) do
+            on(:ok) do
+              flash[:notice] = I18n.t("translations.import.success", scope: "decidim.term_customizer.admin")
+              redirect_to translation_set_translations_path(set)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("translations.import.error", scope: "decidim.term_customizer.admin")
+              render action: "new_import"
+            end
+          end
+        end
+
         private
 
         def translation_set

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationsDestroysController < Admin::ApplicationController
+        helper_method :set
+
+        before_action :set_form
+
+        def new
+          enforce_permission_to :destroy, :translations, translation_set: set
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :translations, translation_set: set
+
+          Admin::DestroyTranslations.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("translations_destroys.destroy.success", scope: "decidim.term_customizer.admin")
+              redirect_to translation_set_translations_path(set)
+            end
+
+            on(:invalid) do
+              if @form.translations.count < 1
+                flash[:alert] = I18n.t("translations_destroys.destroy.error", scope: "decidim.term_customizer.admin")
+                redirect_to translation_set_translations_path(set)
+              else
+                flash.now[:alert] = I18n.t("translations_destroys.destroy.error", scope: "decidim.term_customizer.admin")
+                render action: "new"
+              end
+            end
+          end
+        end
+
+        private
+
+        def set_form
+          @form = form(Admin::TranslationsDestroyForm).from_params(
+            params
+          ).with_context(translation_set: set)
+        end
+
+        def translation_set
+          @translation_set ||= OrganizationTranslationSets.new(
+            current_organization
+          ).query.find(params[:translation_set_id])
+        end
+
+        alias set translation_set
+      end
+    end
+  end
+end

data/app/forms/decidim/term_customizer/admin/translations_destroy_form.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      # A form object to be used when admin users wants to destroy multiple
+      # translations at once.
+      class TranslationsDestroyForm < Decidim::Form
+        mimic :translations_destroy
+
+        delegate :translation_set, to: :context, prefix: false, allow_nil: true
+
+        attribute :translation_ids, Array
+        validates :translation_set, :translations, presence: true
+
+        # Translations for all locales corresponding the translations passed
+        # to the form.
+        def translations
+          return [] unless translation_set
+
+          @translations ||= translation_set.translations.where(
+            key: translation_keys
+          )
+        end
+
+        # Only the translations passed with the IDs (current locale).
+        def translations_current
+          return [] unless translation_set
+
+          @translations_current ||= translation_set.translations.where(
+            id: translation_ids
+          ).uniq
+        end
+
+        private
+
+        # Because we want to delete all locales for the translations to be
+        # deleted, find the corresponding keys for the translation IDs passed
+        # from the UI (current locale).
+        def translation_keys
+          @translation_keys ||= translations_current.map(&:key).uniq
+        end
+      end
+    end
+  end
+end