decidim-surveys 0.3.0

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

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # Exposes the survey resource so users can view and answer them.
+    class SurveysController < Decidim::Surveys::ApplicationController
+      include FormFactory
+
+      helper_method :survey
+
+      def show
+        @form = form(SurveyForm).from_model(survey)
+      end
+
+      def answer
+        authorize! :answer, Survey
+        @form = form(SurveyForm).from_params(params)
+
+        AnswerSurvey.call(@form, current_user, survey) do
+          on(:ok) do
+            flash[:notice] = I18n.t("surveys.answer.success", scope: "decidim.surveys")
+            redirect_to survey_path(survey)
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("surveys.answer.invalid", scope: "decidim.surveys")
+            render action: "show"
+          end
+        end
+      end
+
+      private
+
+      def survey
+        @survey ||= Survey.find_by(feature: current_feature)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This class holds a Form to update surveys from Decidim's admin panel.
+      class SurveyForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+        translatable_attribute :tos, String
+        attribute :published_at, DateTime
+
+        attribute :questions, Array[SurveyQuestionForm]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This class holds a Form to update survey question answer options
+      class SurveyQuestionAnswerOptionForm < Decidim::Form
+        include TranslatableAttributes
+
+        attribute :body, String
+        translatable_attribute :body, String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This class holds a Form to update survey questions from Decidim's admin panel.
+      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 :deleted, Boolean, default: false
+
+        translatable_attribute :body, String
+
+        validates :position, numericality: { greater_than_or_equal_to: 0 }
+        validates :question_type, inclusion: { in: SurveyQuestion::TYPES }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This class holds a Form to update survey unswers from Decidim's public page
+    class SurveyAnswerForm < Decidim::Form
+      attribute :question_id, String
+      attribute :body, String
+
+      validates :body, presence: true, if: -> { question.mandatory? }
+      validate :body_not_blank, if: -> { question.mandatory? }
+
+      def question
+        @question ||= survey.questions.find(question_id)
+      end
+
+      # Public: Map the correct fields.
+      #
+      # Returns nothing.
+      def map_model(model)
+        self.question_id = model.id
+      end
+
+      private
+
+      def survey
+        @survey ||= Survey.where(feature: current_feature).first
+      end
+
+      def body_not_blank
+        return if body.nil?
+        errors.add("body", :blank) if body.all?(&:blank?)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This class holds a Form to answer a surveys from Decidim's public page.
+    class SurveyForm < Decidim::Form
+      attribute :answers, Array[SurveyAnswerForm]
+
+      attribute :tos_agreement, Boolean
+      validates :tos_agreement, allow_nil: false, acceptance: true
+
+      # Private: Create the answers from the survey questions
+      #
+      # Returns nothing.
+      def map_model(model)
+        self.answers = model.questions.map do |question|
+          SurveyAnswerForm.from_params(question_id: question.id)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # Custom helpers, scoped to the surveys engine.
+      #
+      module ApplicationHelper
+        def tabs_id_for_question(question)
+          return "survey-question-#{question.id}" if question.persisted?
+          "${tabsId}"
+        end
+
+        def tabs_id_for_question_answer_option(question, idx)
+          return "survey-question-answer-option-#{question.id}-#{idx}" if question.present?
+          "${tabsId}"
+        end
+
+        def label_for_question(survey, _question)
+          survey.questions_editable? ? "#{icon("move")} #{t(".question")}".html_safe : t(".question")
+        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?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Abilities
+      # Defines the abilities related to surveys for a logged in admin user.
+      # Intended to be used with `cancancan`.
+      class AdminUser
+        include CanCan::Ability
+
+        attr_reader :user, :context
+
+        def initialize(user, context)
+          return unless user && user.role?(:admin)
+
+          @user = user
+          @context = context
+
+          can :manage, Survey
+        end
+
+        private
+
+        def current_settings
+          context.fetch(:current_settings, nil)
+        end
+
+        def feature_settings
+          context.fetch(:feature_settings, nil)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Abilities
+      # Defines the abilities related to surveys for a logged in user.
+      # Intended to be used with `cancancan`.
+      class CurrentUser
+        include CanCan::Ability
+
+        attr_reader :user, :context
+
+        def initialize(user, context)
+          return unless user
+
+          @user = user
+          @context = context
+
+          can :answer, Survey if authorized?(:answer)
+        end
+
+        private
+
+        def authorized?(action)
+          return unless feature
+
+          ActionAuthorizer.new(user, feature, action).authorize.ok?
+        end
+
+        def current_settings
+          context.fetch(:current_settings, nil)
+        end
+
+        def feature_settings
+          context.fetch(:feature_settings, nil)
+        end
+
+        def feature
+          feature = context.fetch(:current_feature, nil)
+          return nil unless feature && feature.manifest.name == :surveys
+
+          feature
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Abilities
+      # Defines the abilities related to surveys for a logged in process admin user.
+      # Intended to be used with `cancancan`.
+      class ProcessAdminUser
+        include CanCan::Ability
+
+        attr_reader :user, :context
+
+        def initialize(user, context)
+          return unless user && !user.role?(:admin)
+
+          @user = user
+          @context = context
+
+          can :manage, Survey do |survey|
+            participatory_processes.include?(survey.feature.participatory_process)
+          end
+        end
+
+        private
+
+        def current_settings
+          context.fetch(:current_settings, nil)
+        end
+
+        def feature_settings
+          context.fetch(:feature_settings, nil)
+        end
+
+        def current_feature
+          context.fetch(:current_feature, nil)
+        end
+
+        def participatory_processes
+          @participatory_processes ||= Decidim::Admin::ManageableParticipatoryProcessesForUser.for(@user)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # 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/surveys/survey.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # The data store for a Survey in the Decidim::Surveys component.
+    class Survey < Surveys::ApplicationRecord
+      include Decidim::HasFeature
+
+      feature_manifest_name "surveys"
+
+      has_many :questions, -> { order(:position) }, class_name: "SurveyQuestion", foreign_key: "decidim_survey_id"
+      has_many :answers, class_name: "SurveyAnswer", foreign_key: "decidim_survey_id"
+
+      # Public: returns whether the survey questions can be modified or not.
+      def questions_editable?
+        answers.empty?
+      end
+
+      # Public: returns whether the survey is answered by the user or not.
+      def answered_by?(user)
+        answers.where(user: user).count == questions.length
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # The data store for a SurveyAnswer in the Decidim::Surveys component.
+    class SurveyAnswer < Surveys::ApplicationRecord
+      belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
+      belongs_to :survey, class_name: "Survey", foreign_key: "decidim_survey_id"
+      belongs_to :question, class_name: "SurveyQuestion", foreign_key: "decidim_survey_question_id"
+
+      validates :body, presence: true, if: -> { question.mandatory? }
+      validate :user_survey_same_organization
+      validate :question_belongs_to_survey
+
+      private
+
+      def user_survey_same_organization
+        return if user&.organization == survey&.organization
+        errors.add(:user, :invalid)
+      end
+
+      def question_belongs_to_survey
+        errors.add(:survey, :invalid) if question&.survey != survey
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # The data store for a SurveyQuestion in the Decidim::Surveys component.
+    class SurveyQuestion < Surveys::ApplicationRecord
+      TYPES = %w(short_answer long_answer single_option multiple_option).freeze
+
+      belongs_to :survey, class_name: "Survey", foreign_key: "decidim_survey_id"
+
+      # Rectify can't handle a hash when using the from_model method so
+      # the answer options must be converted to struct.
+      def answer_options
+        self[:answer_options].map { |option| OpenStruct.new(option) }
+      end
+    end
+  end
+end

data/app/queries/decidim/surveys/survey_user_answers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # A class used to collect user answers for a survey
+    class SurveyUserAnswers < Rectify::Query
+      # Syntactic sugar to initialize the class and return the queried objects.
+      #
+      # survey - a Survey object
+      def self.for(survey)
+        new(survey).query
+      end
+
+      # Initializes the class.
+      #
+      # survey = a Survey object
+      def initialize(survey)
+        @survey = survey
+      end
+
+      # Finds and group answers by user for each survey's question.
+      def query
+        answers = SurveyAnswer.where(survey: @survey)
+        answers.sort_by { |answer| answer.question.position }.group_by(&:user).values
+      end
+    end
+  end
+end