decidim-surveys 0.10.1 → 0.11.0.pre1

data/app/commands/decidim/surveys/admin/update_survey.rb

@@ -33,24 +33,45 @@ module Decidim
 
         def update_survey_questions
           @form.questions.each do |form_question|
-            question_attributes = {
-              body: form_question.body,
-              position: form_question.position,
-              mandatory: form_question.mandatory,
-              question_type: form_question.question_type,
-              answer_options: form_question.answer_options.map { |answer| { "body" => answer.body } }
-            }
+            update_survey_question(form_question)
+          end
+        end
+
+        def update_survey_question(form_question)
+          question_attributes = {
+            body: form_question.body,
+            description: form_question.description,
+            position: form_question.position,
+            mandatory: form_question.mandatory,
+            question_type: form_question.question_type,
+            max_choices: form_question.max_choices
+          }
+
+          update_nested_model(form_question, question_attributes, @survey.questions) do |question|
+            form_question.answer_options.each do |form_answer_option|
+              answer_option_attributes = {
+                body: form_answer_option.body,
+                free_text: form_answer_option.free_text
+              }
+
+              update_nested_model(form_answer_option, answer_option_attributes, question.answer_options)
+            end
+          end
+        end
+
+        def update_nested_model(form, attributes, parent_association)
+          record = parent_association.find_by(id: form.id) || parent_association.build(attributes)
+
+          yield record if block_given?
 
-            if form_question.id.present?
-              question = @survey.questions.where(id: form_question.id).first
-              if form_question.deleted?
-                question.destroy!
-              else
-                question.update!(question_attributes)
-              end
+          if record.persisted?
+            if form.deleted?
+              record.destroy!
             else
-              @survey.questions.create!(question_attributes)
+              record.update!(attributes)
             end
+          else
+            record.save!
           end
         end
 

data/app/commands/decidim/surveys/answer_survey.rb

@@ -29,12 +29,23 @@ module Decidim
       def answer_survey
         SurveyAnswer.transaction do
           @form.answers.each do |form_answer|
-            SurveyAnswer.create!(
+            answer = SurveyAnswer.new(
               user: @current_user,
               survey: @survey,
               question: form_answer.question,
               body: form_answer.body
             )
+
+            form_answer.selected_choices.each do |choice|
+              answer.choices.build(
+                body: choice.body,
+                custom_body: choice.custom_body,
+                decidim_survey_answer_option_id: choice.answer_option_id,
+                position: choice.position
+              )
+            end
+
+            answer.save!
           end
         end
       end

data/app/commands/decidim/surveys/create_survey.rb

@@ -2,15 +2,15 @@
 
 module Decidim
   module Surveys
-    # Command that gets called whenever a feature's survey has to be created. It
-    # usually happens as a callback when the feature itself is created.
+    # Command that gets called whenever a component's survey has to be created. It
+    # usually happens as a callback when the component itself is created.
     class CreateSurvey < Rectify::Command
-      def initialize(feature)
-        @feature = feature
+      def initialize(component)
+        @component = component
       end
 
       def call
-        @survey = Survey.new(feature: @feature)
+        @survey = Survey.new(component: @component)
 
         @survey.save ? broadcast(:ok) : broadcast(:invalid)
       end

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

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

data/app/controllers/decidim/surveys/admin/surveys_controller.rb

@@ -33,15 +33,15 @@ module Decidim
         private
 
         def survey
-          @survey ||= Survey.find_by(feature: current_feature)
+          @survey ||= Survey.find_by(component: current_component)
         end
 
         def blank_question
-          @blank_question ||= survey.questions.build(body: {}, answer_options: [])
+          @blank_question ||= Admin::SurveyQuestionForm.new
         end
 
         def blank_answer_option
-          @blank_answer_option ||= OpenStruct.new(body: {})
+          @blank_answer_option ||= Admin::SurveyAnswerOptionForm.new
         end
 
         def question_types

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

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

data/app/controllers/decidim/surveys/surveys_controller.rb

@@ -32,7 +32,7 @@ module Decidim
       private
 
       def survey
-        @survey ||= Survey.find_by(feature: current_feature)
+        @survey ||= Survey.find_by(component: current_component)
       end
     end
   end

data/app/forms/decidim/surveys/admin/survey_answer_option_form.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This class holds a Form to update survey question answer options
+      class SurveyAnswerOptionForm < Decidim::Form
+        include TranslatableAttributes
+
+        attribute :deleted, Boolean, default: false
+        attribute :free_text, Boolean
+
+        translatable_attribute :body, String
+
+        validates :body, translatable_presence: true, unless: :deleted
+
+        def to_param
+          id || "survey-question-answer-option-id"
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/surveys/admin/survey_form.rb

@@ -10,11 +10,17 @@ module Decidim
         translatable_attribute :title, String
         translatable_attribute :description, String
         translatable_attribute :tos, String
-        attribute :published_at, DateTime
 
+        attribute :published_at, DateTime
         attribute :questions, Array[SurveyQuestionForm]
 
         validates :title, :tos, translatable_presence: true
+
+        def map_model(model)
+          self.questions = model.questions.map do |question|
+            SurveyQuestionForm.from_model(question)
+          end
+        end
       end
     end
   end

data/app/forms/decidim/surveys/admin/survey_question_form.rb

@@ -7,18 +7,28 @@ module Decidim
       class SurveyQuestionForm < Decidim::Form
         include TranslatableAttributes
 
-        attribute :id, String
         attribute :position, Integer
         attribute :mandatory, Boolean, default: false
         attribute :question_type, String
-        attribute :answer_options, Array[SurveyQuestionAnswerOptionForm]
+        attribute :answer_options, Array[SurveyAnswerOptionForm]
+        attribute :max_choices, Integer
         attribute :deleted, Boolean, default: false
 
         translatable_attribute :body, String
+        translatable_attribute :description, String
 
         validates :position, numericality: { greater_than_or_equal_to: 0 }
         validates :question_type, inclusion: { in: SurveyQuestion::TYPES }
+        validates :max_choices, numericality: { only_integer: true, greater_than: 1, less_than_or_equal_to: ->(form) { form.number_of_options } }, allow_blank: true
         validates :body, translatable_presence: true, unless: :deleted
+
+        def to_param
+          id || "survey-question-id"
+        end
+
+        def number_of_options
+          answer_options.size
+        end
       end
     end
   end

data/app/forms/decidim/surveys/survey_answer_choice_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This class holds a Form to update survey question answer options
+    class SurveyAnswerChoiceForm < Decidim::Form
+      attribute :body, String
+      attribute :custom_body, String
+      attribute :position, Integer
+      attribute :answer_option_id, Integer
+
+      validates :answer_option_id, presence: true
+    end
+  end
+end

data/app/forms/decidim/surveys/survey_answer_form.rb

@@ -4,32 +4,66 @@ module Decidim
   module Surveys
     # This class holds a Form to update survey unswers from Decidim's public page
     class SurveyAnswerForm < Decidim::Form
+      include Decidim::TranslationsHelper
+
       attribute :question_id, String
       attribute :body, String
+      attribute :choices, Array[SurveyAnswerChoiceForm]
+
+      validates :body, presence: true, if: :mandatory_body?
+      validates :selected_choices, presence: true, if: :mandatory_choices?
 
-      validates :body, presence: true, if: -> { question.mandatory? }
-      validate :body_not_blank, if: -> { question.mandatory? }
+      validate :max_choices, if: -> { question.max_choices }
+      validate :all_choices, if: -> { question.question_type == "sorting" }
+
+      delegate :mandatory_body?, :mandatory_choices?, to: :question
 
       def question
         @question ||= survey.questions.find(question_id)
       end
 
+      def label(idx)
+        base = "#{idx + 1}. #{translated_attribute(question.body)}"
+        base += " #{mandatory_label}" if question.mandatory?
+        base += " (#{max_choices_label})" if question.max_choices
+        base
+      end
+
       # Public: Map the correct fields.
       #
       # Returns nothing.
       def map_model(model)
         self.question_id = model.decidim_survey_question_id
+
+        self.choices = model.choices.map do |choice|
+          SurveyAnswerChoiceForm.from_model(choice)
+        end
+      end
+
+      def selected_choices
+        choices.select(&:body)
       end
 
       private
 
       def survey
-        @survey ||= Survey.where(feature: current_feature).first
+        @survey ||= Survey.find_by(component: current_component)
+      end
+
+      def max_choices
+        errors.add(:choices, :too_many) if selected_choices.size > question.max_choices
+      end
+
+      def all_choices
+        errors.add(:choices, :missing) if selected_choices.size != question.number_of_options
+      end
+
+      def mandatory_label
+        "*"
       end
 
-      def body_not_blank
-        return if body.nil?
-        errors.add("body", :blank) if body.all?(&:blank?)
+      def max_choices_label
+        I18n.t("surveys.question.max_choices", scope: "decidim.surveys", n: question.max_choices)
       end
     end
   end

data/app/forms/decidim/surveys/survey_form.rb

@@ -14,7 +14,7 @@ module Decidim
       # Returns nothing.
       def map_model(model)
         self.answers = model.questions.map do |question|
-          SurveyAnswerForm.from_params(question_id: question.id)
+          SurveyAnswerForm.from_model(SurveyAnswer.new(question: question))
         end
       end
     end

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

@@ -7,27 +7,11 @@ module Decidim
       #
       module ApplicationHelper
         def tabs_id_for_question(question)
-          return "survey-question-#{question.id}" if question.persisted?
-          "${tabsId}"
+          "survey_question_#{question.to_param}"
         end
 
-        def tabs_id_for_question_answer_option(question, idx)
-          return "survey-question-answer-option-#{question.id}-#{idx}" if question.present?
-          "${tabsId}"
-        end
-
-        def mandatory_id_for_question(question)
-          return "survey_questions_#{question.id}_mandatory" if question.persisted?
-          "${tabsId}_mandatory"
-        end
-
-        def question_type_id_for_question(question)
-          return "survey_questions_#{question.id}_question_type" if question.persisted?
-          "${tabsId}_question_type"
-        end
-
-        def disabled_for_question(survey, question)
-          !question.persisted? || !survey.questions_editable?
+        def tabs_id_for_question_answer_option(question, answer_option)
+          "survey_question_#{question.to_param}_answer_option_#{answer_option.to_param}"
         end
       end
     end

data/app/jobs/decidim/surveys/settings_change_job.rb

@@ -3,10 +3,10 @@
 module Decidim
   module Surveys
     class SettingsChangeJob < ApplicationJob
-      def perform(feature_id, previous_settings, current_settings)
+      def perform(component_id, previous_settings, current_settings)
         return if unchanged?(previous_settings, current_settings)
 
-        feature = Decidim::Feature.find(feature_id)
+        component = Decidim::Component.find(component_id)
 
         if survey_opened?(previous_settings, current_settings)
           event = "decidim.events.surveys.survey_opened"
@@ -19,8 +19,8 @@ module Decidim
         Decidim::EventsManager.publish(
           event: event,
           event_class: event_class,
-          resource: feature,
-          recipient_ids: feature.participatory_space.followers.pluck(:id)
+          resource: component,
+          recipient_ids: component.participatory_space.followers.pluck(:id)
         )
       end
 

data/app/models/decidim/surveys/abilities/current_user_ability.rb

@@ -22,24 +22,24 @@ module Decidim
         private
 
         def authorized?(action)
-          return unless feature
+          return unless component
 
-          ActionAuthorizer.new(user, feature, action).authorize.ok?
+          ActionAuthorizer.new(user, component, action).authorize.ok?
         end
 
         def current_settings
           context.fetch(:current_settings, nil)
         end
 
-        def feature_settings
-          context.fetch(:feature_settings, nil)
+        def component_settings
+          context.fetch(:component_settings, nil)
         end
 
-        def feature
-          feature = context.fetch(:current_feature, nil)
-          return nil unless feature && feature.manifest.name == :surveys
+        def component
+          component = context.fetch(:current_component, nil)
+          return nil unless component && component.manifest.name == :surveys
 
-          feature
+          component
         end
       end
     end

data/app/models/decidim/surveys/abilities/participatory_process_admin_ability.rb

@@ -10,7 +10,7 @@ module Decidim
           super
 
           can :manage, Survey do |survey|
-            can_manage_process?(survey.feature.participatory_space)
+            can_manage_process?(survey.component.participatory_space)
           end
         end
       end

data/app/models/decidim/surveys/survey.rb

@@ -4,9 +4,9 @@ module Decidim
   module Surveys
     # The data store for a Survey in the Decidim::Surveys component.
     class Survey < Surveys::ApplicationRecord
-      include Decidim::HasFeature
+      include Decidim::HasComponent
 
-      feature_manifest_name "surveys"
+      component_manifest_name "surveys"
 
       has_many :questions, -> { order(:position) }, class_name: "SurveyQuestion", foreign_key: "decidim_survey_id", dependent: :destroy
       has_many :answers, class_name: "SurveyAnswer", foreign_key: "decidim_survey_id", dependent: :destroy