decidim-term_customizer 0.16.0

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationsController < TermCustomizer::Admin::ApplicationController
+        helper_method :collection, :set, :translations, :translation
+
+        def index
+          enforce_permission_to :read, :translation
+          @translations = collection
+        end
+
+        def new
+          enforce_permission_to :create, :translation
+
+          @form = form(TranslationForm).from_model(Translation.new)
+        end
+
+        def create
+          enforce_permission_to :create, :translation
+          @form = form(TranslationForm).from_params(
+            params,
+            current_organization: current_organization,
+            translation_set: set
+          )
+
+          CreateTranslation.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("translations.create.success", scope: "decidim.term_customizer.admin")
+              redirect_to translation_set_translations_path(set)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("translations.create.error", scope: "decidim.term_customizer.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :translation, translation: translation
+          @form = form(TranslationForm).from_model(translation)
+        end
+
+        def update
+          enforce_permission_to :update, :translation, translation: translation
+          @form = form(TranslationForm).from_params(
+            params,
+            current_organization: current_organization,
+            translation_set: set
+          )
+
+          UpdateTranslation.call(@form, translation) do
+            on(:ok) do
+              flash[:notice] = I18n.t("translations.update.success", scope: "decidim.term_customizer.admin")
+              redirect_to translation_set_translations_path(set)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("translations.update.invalid", scope: "decidim.term_customizer.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :translation, translation: translation
+
+          # Destroy all locales of the translation key
+          Decidim::TermCustomizer::Translation.where(
+            translation_set: set,
+            key: translation.key
+          ).destroy_all
+
+          flash[:notice] = I18n.t("translations.destroy.success", scope: "decidim.term_customizer.admin")
+
+          redirect_to translation_set_translations_path(set)
+        end
+
+        private
+
+        def translation_set
+          @translation_set ||= OrganizationTranslationSets.new(
+            current_organization
+          ).query.find(params[:translation_set_id])
+        end
+
+        def translations
+          @translations ||= SetTranslations.new(translation_set, current_locale)
+        end
+
+        def translation
+          @translation ||= Decidim::TermCustomizer::Translation.find(params[:id])
+        end
+
+        alias collection translations
+        alias set translation_set
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationForm < Decidim::Form
+        include TranslatableAttributes
+
+        mimic :translation
+
+        delegate :translation_set, to: :context, prefix: false, allow_nil: true
+
+        attribute :key, String
+        translatable_attribute :value, String
+
+        validates :key, presence: true
+        validates :key, format: { with: %r{\A([a-z0-9_/]+\.?)*[a-z0-9_/]+\z} }, unless: -> { key.blank? }
+        validates :value, translatable_presence: true
+        validate :key_uniqueness
+
+        def map_model(model)
+          self.value = Hash[Decidim::TermCustomizer::Translation.where(
+            translation_set: model.translation_set,
+            key: model.key
+          ).map do |translation|
+            [translation.locale, translation.value]
+          end]
+        end
+
+        def key_uniqueness
+          errors.add(:key, :taken) if translation_set && translation_set.translations.where(
+            locale: I18n.locale,
+            key: key
+          ).exists?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationKeyImportForm < Decidim::Form
+        mimic :translation
+
+        delegate :translation_set, to: :context, prefix: false, allow_nil: true
+
+        attribute :keys, Array[String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationSetConstraintForm < Decidim::Form
+        mimic :constraint
+
+        attribute :subject_manifest, String
+        attribute :subject_model, Array[TermCustomizer::Admin::TranslationSetSubjectForm]
+        attribute :deleted, Boolean, default: false
+
+        def to_param
+          return id if id.present?
+
+          "constraint-id"
+        end
+
+        def map_model(model)
+          self.subject_manifest = model.manifest_name
+
+          return unless model.subject
+
+          self.subject_model = [
+            TermCustomizer::Admin::TranslationSetSubjectForm.from_model(
+              model.subject
+            )
+          ]
+        end
+
+        def subject_type
+          return unless subject_form
+
+          subject_form.manifest.try(:model_class_name)
+        end
+
+        def subject
+          return component if component
+          return unless subject_form
+
+          subject_form.subject
+        end
+
+        def component
+          return unless subject_form
+
+          subject_form.component
+        end
+
+        def subject_form
+          @subject_form ||= subject_model.find do |sm|
+            sm.subject_manifest == subject_manifest
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationSetForm < Decidim::Form
+        include TranslatableAttributes
+
+        mimic :translation_set
+
+        translatable_attribute :name, String
+        attribute :constraints, Array[TermCustomizer::Admin::TranslationSetConstraintForm]
+
+        validates :name, translatable_presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationSetSubjectComponentForm < Decidim::Form
+        attribute :subject_id, Integer
+        attribute :component_id, Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class TranslationSetSubjectForm < Decidim::Form
+        attribute :subject_manifest, String
+        attribute :subject_id, Integer
+        attribute :component_model, Array[TermCustomizer::Admin::TranslationSetSubjectComponentForm]
+
+        def map_model(model)
+          component = model if model.is_a?(Decidim::Component)
+          subject = if component
+                      model.participatory_space
+                    else
+                      model
+                    end
+
+          self.subject_manifest = Decidim.participatory_space_manifests.find do |m|
+            m.model_class_name == subject.class.name
+          end.try(:name)
+          self.subject_id = subject.id
+
+          return unless component
+
+          self.component_model = [
+            TermCustomizer::Admin::TranslationSetSubjectComponentForm.from_params(
+              subject_id: subject.id,
+              component_id: component.id
+            )
+          ]
+        end
+
+        def subject
+          return unless manifest
+
+          @subject ||= manifest.model_class_name.constantize.find_by(id: subject_id)
+        end
+
+        def component
+          return unless component_form
+          return unless subject
+
+          subject.components.find_by(id: component_form.component_id)
+        end
+
+        def manifest
+          @manifest ||= Decidim.participatory_space_manifests.find do |m|
+            m.name == subject_manifest.to_sym
+          end
+        end
+
+        def component_form
+          @component_form ||= component_model.find do |cm|
+            cm.subject_id == subject_id
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/term_customizer/admin/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      module ApplicationHelper
+        def tabs_id_for_constraint(constraint)
+          "constraint_#{constraint.to_param}"
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/term_customizer/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/term_customizer/constraint.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    class Constraint < TermCustomizer::ApplicationRecord
+      self.table_name = "decidim_term_customizer_constraints"
+
+      belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+      belongs_to :translation_set, class_name: "Decidim::TermCustomizer::TranslationSet", foreign_key: "translation_set_id"
+      belongs_to :subject, optional: true, polymorphic: true
+      has_many :translations, through: :translation_set
+
+      def component
+        subject if subject.is_a?(Decidim::Component)
+      end
+
+      def space
+        return component.participatory_space if component
+
+        subject
+      end
+
+      def manifest
+        space_class = space ? space.class.name : subject_type
+
+        Decidim.participatory_space_manifests.find do |manifest|
+          manifest.model_class_name == space_class
+        end
+      end
+
+      def manifest_name
+        manifest.try(:name)
+      end
+    end
+  end
+end

data/app/models/decidim/term_customizer/translation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    class Translation < TermCustomizer::ApplicationRecord
+      self.table_name = "decidim_term_customizer_translations"
+
+      belongs_to :translation_set, class_name: "Decidim::TermCustomizer::TranslationSet", foreign_key: "translation_set_id"
+      has_many :constraints, through: :translation_set
+
+      validates :locale, presence: true
+      validates :key, presence: true
+      validates :key, format: { with: %r{\A([a-z0-9_/]+\.?)*[a-z0-9_/]+\z} }, unless: -> { key.blank? }
+      validates :key, uniqueness: { scope: [:translation_set, :locale] }, unless: -> { key.blank? }
+
+      class << self
+        def available_locales
+          Translation.select("DISTINCT locale").to_a.map { |t| t.locale.to_sym }
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/term_customizer/translation_set.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    class TranslationSet < TermCustomizer::ApplicationRecord
+      self.table_name = "decidim_term_customizer_translation_sets"
+
+      has_many :translations,
+               class_name: "Decidim::TermCustomizer::Translation",
+               foreign_key: :translation_set_id,
+               dependent: :destroy
+
+      has_many :constraints,
+               class_name: "Decidim::TermCustomizer::Constraint",
+               foreign_key: :translation_set_id,
+               dependent: :destroy
+    end
+  end
+end

data/app/permissions/decidim/term_customizer/admin/permissions.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TermCustomizer
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action unless user
+          return permission_action unless permission_action.scope == :admin
+
+          unless user.admin?
+            disallow!
+            return permission_action
+          end
+
+          if read_admin_dashboard_action?
+            allow!
+            return permission_action
+          end
+
+          allowed_translation_set_action?
+          allowed_translation_action?
+
+          permission_action
+        end
+
+        private
+
+        def translation_set
+          @translation_set ||= context.fetch(:translation_set, nil)
+        end
+
+        def translation
+          @translation ||= context.fetch(:translation, nil)
+        end
+
+        def allowed_translation_set_action?
+          return unless permission_action.subject == :translation_set
+
+          case permission_action.action
+          when :create, :read
+            allow!
+          when :update, :destroy
+            toggle_allow(translation_set.present?)
+          end
+        end
+
+        def allowed_translation_action?
+          return unless permission_action.subject == :translation
+
+          case permission_action.action
+          when :create, :read
+            allow!
+          when :update, :destroy
+            toggle_allow(translation.present?)
+          end
+        end
+
+        def read_admin_dashboard_action?
+          permission_action.action == :read &&
+            permission_action.subject == :admin_dashboard
+        end
+      end
+    end
+  end
+end