decidim-templates 0.23.0

data/app/controllers/decidim/templates/admin/questionnaire_templates_controller.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # Controller that allows managing templates.
+      #
+      class QuestionnaireTemplatesController < Decidim::Templates::Admin::ApplicationController
+        include Decidim::TranslatableAttributes
+
+        skip_before_action :verify_authenticity_token, only: :preview
+
+        helper_method :template
+
+        def index
+          enforce_permission_to :index, :templates
+          @templates = collection
+
+          respond_to do |format|
+            format.html { render :index }
+            format.json do
+              term = params[:term]
+
+              @templates = search(term)
+
+              render json: @templates.map { |t| { value: t.id, label: translated_attribute(t.name) } }
+            end
+          end
+        end
+
+        def new
+          enforce_permission_to :create, :template
+          @form = form(TemplateForm).instance
+        end
+
+        def create
+          enforce_permission_to :create, :template
+
+          @form = form(TemplateForm).from_params(params)
+
+          CreateQuestionnaireTemplate.call(@form) do
+            on(:ok) do |questionnaire_template|
+              flash[:notice] = I18n.t("templates.create.success", scope: "decidim.admin")
+              redirect_to edit_questionnaire_template_path(questionnaire_template)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("templates.create.error", scope: "decidim.admin")
+              render :new
+            end
+          end
+        end
+
+        def copy
+          enforce_permission_to :copy, :template
+
+          CopyQuestionnaireTemplate.call(template) do
+            on(:ok) do
+              flash[:notice] = I18n.t("templates.copy.success", scope: "decidim.admin")
+              redirect_to action: :index
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("templates.copy.error", scope: "decidim.admin")
+              redirect_to action: :index
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :template, template: template
+          @form = form(TemplateForm).from_model(template)
+          @preview_form = form(Decidim::Forms::QuestionnaireForm).from_model(template.templatable)
+        end
+
+        def update
+          enforce_permission_to :update, :template, template: template
+          @form = form(TemplateForm).from_params(params)
+          UpdateTemplate.call(template, @form, current_user) do
+            on(:ok) do |questionnaire_template|
+              flash[:notice] = I18n.t("templates.update.success", scope: "decidim.admin")
+              redirect_to edit_questionnaire_template_path(questionnaire_template)
+            end
+
+            on(:invalid) do |template|
+              @template = template
+              flash.now[:error] = I18n.t("templates.update.error", scope: "decidim.admin")
+              render action: :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :template, template: template
+
+          DestroyTemplate.call(template, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("templates.destroy.success", scope: "decidim.admin")
+              redirect_to action: :index
+            end
+          end
+        end
+
+        def apply
+          questionnaire = Decidim::Forms::Questionnaire.find_by(id: params[:questionnaire_id])
+          template = Decidim::Templates::Template.find_by(id: params[:questionnaire][:questionnaire_template_id])
+
+          ApplyQuestionnaireTemplate.call(questionnaire, template) do
+            on(:ok) do
+              flash[:notice] = I18n.t("templates.apply.success", scope: "decidim.admin")
+              redirect_to params[:url]
+            end
+            on(:invalid) do
+              flash.now[:error] = I18n.t("templates.apply.error", scope: "decidim.admin")
+            end
+          end
+        end
+
+        def preview
+          respond_to do |format|
+            format.js do
+              @template = template
+              @questionnaire = @template.templatable
+              @preview_form = form(Decidim::Forms::QuestionnaireForm).from_model(@questionnaire)
+            end
+          end
+        end
+
+        def skip
+          questionnaire = Decidim::Forms::Questionnaire.find_by(id: params[:questionnaire_id])
+          # rubocop:disable Rails/SkipsModelValidations
+          questionnaire.touch
+          # rubocop:enable Rails/SkipsModelValidations
+          redirect_to params[:url]
+        end
+
+        private
+
+        def collection
+          @collection ||= current_organization.templates.where(templatable_type: "Decidim::Forms::Questionnaire")
+        end
+
+        def template
+          @template ||= Template.find_by(id: params[:id])
+        end
+
+        def search(term)
+          locales = current_organization.available_locales
+          @templates
+            .where(locales.map { |l| "name ->> '#{l}' ILIKE :text" }.join(" OR "), text: "%#{term}%")
+            .or(@templates.where(locales.map { |l| "description ->> '#{l}' ILIKE :text" }.join(" OR "), text: "%#{term}%"))
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/templates/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/forms/decidim/templates/admin/template_form.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # This class holds a Form to update templates.
+      class TemplateForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :name, String
+        translatable_attribute :description, String
+
+        validates :name, translatable_presence: true
+      end
+    end
+  end
+end

data/app/helpers/decidim/templates/admin/templates_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # Custom helpers, scoped to the templates engine.
+      #
+      module TemplatesHelper
+        def select_template(form, templates)
+          prompt_options = {
+            url: decidim_admin_templates.questionnaire_templates_url(format: :json),
+            change_url: decidim_admin_templates.preview_questionnaire_templates_url(format: :js),
+            placeholder: t("placeholder", scope: "decidim.templates.admin.questionnaire_templates.choose")
+          }
+
+          default_options = templates.last(5).map { |questionnaire_template| { value: questionnaire_template.id, label: translated_attribute(questionnaire_template.name) } }
+
+          form.autocomplete_select(
+            :questionnaire_template_id,
+            false,
+            {
+              multiple: false,
+              label: t("label", scope: "decidim.templates.admin.questionnaire_templates.choose"),
+              default_options: default_options
+            },
+            prompt_options
+          )
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/templates/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    # Custom helpers, scoped to the templates engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/concerns/decidim/templates/templatable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Templates
+    # A concern with the components needed when you want to create templates for a model
+    module Templatable
+      extend ActiveSupport::Concern
+
+      included do
+        has_one :template,
+                class_name: "Decidim::Templates::Template",
+                inverse_of: :templatable,
+                dependent: :destroy,
+                as: :templatable
+
+        def pristine?
+          created_at.to_i == updated_at.to_i
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    # 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/templates/template.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Templates can be defined from the admin panel to store and use objects
+# with given values and use them to create new ones using these values as default
+#
+# The model class we want to create these templates from must include the Templatable
+# concern. A controller should be created to manage templates for the model,
+# as well as the routes for the controller actions. The command classes to use in
+# these actions should also be created to define the particular data management
+# for the model's templates.
+module Decidim
+  module Templates
+    class Template < ApplicationRecord
+      belongs_to :organization,
+                 foreign_key: "decidim_organization_id",
+                 class_name: "Decidim::Organization"
+
+      belongs_to :templatable, foreign_key: "templatable_id", foreign_type: "templatable_type", polymorphic: true, optional: true
+
+      before_destroy :destroy_templatable
+
+      validates :name, presence: true
+
+      def resource_name
+        [templatable_type.demodulize.tableize.singularize, "templates"].join("_")
+      end
+
+      def destroy_templatable
+        templatable.destroy
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action unless user
+
+          return permission_action if permission_action.scope != :admin
+
+          case permission_action.subject
+          when :template
+            allow! if [:read, :create, :update, :destroy, :copy].include? permission_action.action
+          when :templates
+            allow! if permission_action.action == :index
+          when :questionnaire
+            allow!
+          end
+
+          permission_action
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/templates/admin/questionnaire_templates/_choose.html.erb

@@ -0,0 +1,35 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= form_title %></h2>
+    <div class="button--title">
+      <%= link_to t(".skip_template"), decidim_admin_templates.skip_questionnaire_templates_path(questionnaire_id: questionnaire, url: request.url), class: "button tiny button--simple", method: :post %>
+    </div>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= t(".description") %>
+    </div>
+
+    <%= decidim_form_for([questionnaire], url: decidim_admin_templates.apply_questionnaire_templates_url(questionnaire_id: questionnaire, url: request.url), method: :post, html: { class: "form choose_questionnaire_templates" }) do |form| %>
+      <div class="row column">
+        <%= select_template form, templates %>
+      </div>
+
+      <div class="card-section questionnaire-template-preview">
+        <h3 class="template-name"></h3>
+        <p class="template-description"></p>
+        <div class="row column">
+          <div class="row column choose-template-preview">
+          </div>
+        </div>
+      </div>
+
+      <div class="button--double form-general-submit create-from-template">
+        <%= form.submit t(".create_from_template"), class: "button" %>
+      </div>
+    <% end %>
+  </div>
+</div>
+
+<%= stylesheet_link_tag "decidim/templates/templates", media: "all" %>

data/app/views/decidim/templates/admin/questionnaire_templates/_form.html.erb

@@ -0,0 +1,16 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= t(".template_title") %></h2>
+    <%= form.submit t(".save"), class: "button tiny button--title" %>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :name %>
+    </div>
+
+    <div class="row column">
+      <%= form.translated :text_area, :description, rows: 3 %>
+    </div>
+  </div>
+</div>

data/app/views/decidim/templates/admin/questionnaire_templates/_preview.html.erb

@@ -0,0 +1,73 @@
+<% columns = @preview_form.responses.map(&:question).any?(&:matrix?) ? 9 : 6 %>
+
+<div class="row columns">
+  <h3 class="section-heading"><%= translated_attribute questionnaire.title %></h3>
+  <div class="row">
+    <div class="columns large-<%= columns %> medium-centered lead">
+      <%= decidim_sanitize translated_attribute questionnaire.description %>
+    </div>
+  </div>
+</div>
+
+<div class="row">
+  <div class="columns large-<%= columns %> medium-centered">
+    <div class="card">
+      <div class="card__content">
+        <div class="answer-questionnaire">
+          <%= decidim_form_for(@preview_form, url: "", method: :post, html: { class: "form answer-questionnaire" }, data: { "safe-path" => "" }) do |form| %>
+            <%= invisible_captcha %>
+            <% answer_idx = 0 %>
+            <% cleaned_answer_idx = 0 %>
+            <% @preview_form.responses_by_step.each_with_index do |step_answers, step_index| %>
+              <div id="step-<%= step_index %>" class="<%= step_index.zero? ? "questionnaire-step" : "questionnaire-step hide" %>" data-toggler=".hide">
+                <% if @preview_form.total_steps > 1 %>
+                  <h4 class="section-heading">
+                    <%= t(".current_step", step: step_index + 1) %> <span class="answer-questionnaire__steps"><%= t(".of_total_steps", total_steps: @preview_form.total_steps) %></span>
+                  </h4>
+                <% end %>
+
+                <% step_answers.each do |answer| %>
+                  <div class="row column answer" data-max-choices="<%= answer.question.max_choices %>">
+                    <%= fields_for "questionnaire[responses][#{answer_idx}]", answer do |answer_form| %>
+                      <%= render(
+                        "decidim/forms/questionnaires/answer",
+                        answer_form: answer_form,
+                        answer: answer,
+                        answer_idx: answer_idx,
+                        cleaned_answer_idx: cleaned_answer_idx,
+                        disabled: false
+                      ) %>
+                    <% end %>
+                  </div>
+                  <% if !answer.question.separator? %>
+                    <% cleaned_answer_idx += 1 %>
+                  <% end %>
+                  <% answer_idx += 1 %>
+                <% end %>
+
+                <% if step_index + 1 == @preview_form.total_steps %>
+                  <div class="row column tos-agreement">
+                    <%= form.check_box :tos_agreement, label: t(".tos_agreement"), id: "questionnaire_tos_agreement", disabled: false %>
+                    <div class="help-text">
+                      <%= decidim_sanitize translated_attribute questionnaire.tos %>
+                    </div>
+                  </div>
+                <% end %>
+
+                <%= cell(
+                  "decidim/forms/step_navigation",
+                  step_index,
+                  total_steps: @preview_form.total_steps,
+                  button_disabled: true,
+                  form: form
+                ) %>
+              </div>
+            <% end %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= stylesheet_link_tag "decidim/templates/templates", media: "all" %>