decidim-templates 0.23.0

data/README.md

@@ -0,0 +1,31 @@
+# Decidim::Templates
+
+This module provides a solution to create templates for different Decidim models, such as Proposals and Questionnaires.
+
+## Usage
+
+Templates will be available in their own section in the admin
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-templates'
+```
+
+And then execute:
+
+```bash
+bundle
+bundle exec rails decidim_templates:install:migrations
+bundle exec rails db:migrate
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/app/assets/config/decidim_templates_manifest.css

@@ -0,0 +1,3 @@
+/*
+ *= link decidim/templates/templates.scss
+ */

data/app/assets/images/decidim/templates/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/assets/stylesheets/decidim/templates/templates.scss

@@ -0,0 +1,14 @@
+.questionnaire-template-preview{
+  margin: 2rem;
+  padding: 1rem;
+
+  .card{
+    width: 75%;
+    margin: auto;
+    border: none;
+  }
+}
+
+.choose-template-preview{
+  min-height: 10rem;
+}

data/app/commands/decidim/templates/admin/apply_questionnaire_template.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    # A command with all the business logic when duplicating a questionnaire template
+    module Admin
+      class ApplyQuestionnaireTemplate < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # template - The template we want to apply
+        # questionnaire - The questionnaire we want to use the template
+        def initialize(questionnaire, template)
+          @questionnaire = questionnaire
+          @template = template
+        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 @template.valid?
+
+          Template.transaction do
+            apply_template
+            copy_questionnaire_questions(@template.templatable, @questionnaire)
+          end
+
+          broadcast(:ok, @questionnaire)
+        end
+
+        private
+
+        attr_reader :form
+
+        def apply_template
+          @questionnaire.update!(
+            title: @template.templatable.title,
+            description: @template.templatable.description,
+            tos: @template.templatable.tos
+          )
+        end
+
+        def copy_questionnaire_questions(original_questionnaire, new_questionnaire)
+          original_questionnaire.questions.each do |original_question|
+            new_question = original_question.dup
+            new_question.questionnaire = new_questionnaire
+            new_question.save!
+            copy_questionnaire_answer_options(original_question, new_question)
+            copy_questionnaire_matrix_rows(original_question, new_question)
+          end
+        end
+
+        def copy_questionnaire_answer_options(original_question, new_question)
+          original_question.answer_options.each do |original_answer_option|
+            new_answer_option = original_answer_option.dup
+            new_answer_option.question = new_question
+            new_answer_option.save!
+          end
+        end
+
+        def copy_questionnaire_matrix_rows(original_question, new_question)
+          original_question.matrix_rows.each do |original_matrix_row|
+            new_matrix_row = original_matrix_row.dup
+            new_matrix_row.question = new_question
+            new_matrix_row.save!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/templates/admin/copy_questionnaire_template.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    # A command with all the business logic when duplicating a questionnaire template
+    module Admin
+      class CopyQuestionnaireTemplate < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # template - A template we want to duplicate
+        def initialize(template)
+          @template = template
+        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 @template.valid?
+
+          Template.transaction do
+            copy_template
+            copy_questionnaire_questions(@template.templatable, @copied_template.templatable)
+          end
+
+          broadcast(:ok, @copied_template)
+        end
+
+        private
+
+        attr_reader :form
+
+        def copy_template
+          @copied_template = Template.create!(
+            organization: @template.organization,
+            name: @template.name,
+            description: @template.description
+          )
+          @resource = Decidim::Forms::Questionnaire.create!(
+            @template.templatable.dup.attributes.merge(
+              questionnaire_for: @copied_template
+            )
+          )
+
+          @copied_template.update!(templatable: @resource)
+        end
+
+        def copy_questionnaire_questions(original_questionnaire, new_questionnaire)
+          original_questionnaire.questions.each do |original_question|
+            new_question = original_question.dup
+            new_question.questionnaire = new_questionnaire
+            new_question.save!
+            copy_questionnaire_answer_options(original_question, new_question)
+            copy_questionnaire_matrix_rows(original_question, new_question)
+          end
+        end
+
+        def copy_questionnaire_answer_options(original_question, new_question)
+          original_question.answer_options.each do |original_answer_option|
+            new_answer_option = original_answer_option.dup
+            new_answer_option.question = new_question
+            new_answer_option.save!
+          end
+        end
+
+        def copy_questionnaire_matrix_rows(original_question, new_question)
+          original_question.matrix_rows.each do |original_matrix_row|
+            new_matrix_row = original_matrix_row.dup
+            new_matrix_row.question = new_question
+            new_matrix_row.save!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/templates/admin/create_questionnaire_template.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # Creates a QuestionnaireTemplate.
+      class CreateQuestionnaireTemplate < Rectify::Command
+        # Initializes the command.
+        #
+        # form - The source for this QuestionnaireTemplate.
+        def initialize(form)
+          @form = form
+        end
+
+        def call
+          return broadcast(:invalid) unless @form.valid?
+
+          @template = Decidim.traceability.create!(
+            Template,
+            @form.current_user,
+            name: @form.name,
+            description: @form.description,
+            organization: @form.current_organization
+          )
+
+          @questionnaire = Decidim::Forms::Questionnaire.create!(questionnaire_for: @template)
+          @template.update!(templatable: @questionnaire)
+
+          broadcast(:ok, @template)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/templates/admin/destroy_template.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # This command deals with destroying a template from the admin panel.
+      class DestroyTemplate < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # template - The Template to be destroyed.
+        # user        - The user that destroys the template.
+        def initialize(template, current_user)
+          @template = template
+          @current_user = current_user
+        end
+
+        # Public: Executes the command.
+        #
+        # Broadcasts :ok if it got destroyed
+        def call
+          destroy_template
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :template, :current_user
+
+        def destroy_template
+          Decidim.traceability.perform_action!(
+            :delete,
+            template,
+            current_user
+          ) do
+            template.destroy!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/templates/admin/update_template.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # Updates the questionnaire template given form data.
+      class UpdateTemplate < Rectify::Command
+        # Initializes the command.
+        #
+        # template - The Template to update.
+        # form        - The form object containing the data to update.
+        # user        - The user that updates the template.
+        def initialize(template, form, user)
+          @template = template
+          @form = form
+          @user = user
+        end
+
+        def call
+          return broadcast(:invalid) unless @form.valid?
+          return broadcast(:invalid) unless @user.organization == @template.organization
+
+          @template = Decidim.traceability.update!(
+            @template,
+            @user,
+            name: @form.name,
+            description: @form.description
+          )
+
+          broadcast(:ok, @template)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::ApplicationController`, which
+      # override its layout and provide all kinds of useful methods.
+      #
+      # i18n-tasks-use t('decidim.admin.titles.template_types.questionnaires')
+      class ApplicationController < Decidim::Admin::ApplicationController
+        layout "decidim/admin/templates"
+
+        helper_method :template_types
+
+        register_permissions(::Decidim::Templates::Admin::ApplicationController,
+                             ::Decidim::Templates::Admin::Permissions,
+                             ::Decidim::Admin::Permissions)
+
+        def permission_class_chain
+          ::Decidim.permissions_registry.chain_for(::Decidim::Templates::Admin::ApplicationController)
+        end
+
+        def template_types
+          @template_types ||= {
+            I18n.t("template_types.questionnaires", scope: "decidim.templates") => decidim_admin_templates.questionnaire_templates_path
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/templates/admin/concerns/templatable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Templates
+    module Admin
+      module Concerns
+        module Templatable
+          # Common logic to load template-related resources in controller
+          extend ActiveSupport::Concern
+
+          included do
+            helper_method :templates, :choose_template?
+
+            def templates
+              @templates = current_organization.templates.where(templatable_type: templatable_type)
+              @templates = @templates.where.not(id: params[:id]) if templates_path?
+              @templates
+            end
+
+            def templates_path?
+              controller_path.match?("^decidim/templates/.*")
+            end
+
+            def choose_template?
+              return false if templatable.is_a? Decidim::Templates::Template
+
+              templates.any? && templatable.pristine?
+            end
+
+            protected
+
+            def templatable
+              raise NotImplementedError, "Please set the templatable resource in your controller"
+            end
+
+            def templatable_type
+              raise NotImplementedError, "The templatable type is needed to load resources"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/templates/admin/questionnaire_templates/questionnaires_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Templates
+    module Admin
+      module QuestionnaireTemplates
+        # This controller allows an admin to manage a questionnaire form for a questionnaire_template
+        class QuestionnairesController < Admin::ApplicationController
+          include Decidim::Forms::Admin::Concerns::HasQuestionnaire
+
+          helper Decidim::Admin::ExportsHelper
+
+          def questionnaire_for
+            template
+          end
+
+          def update_url
+            questionnaire_path(template)
+          end
+
+          def after_update_url
+            edit_questionnaire_template_path(id: template.id)
+          end
+
+          def public_url
+            nil
+          end
+
+          private
+
+          def template
+            @template ||= Template.find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end