decidim-consultations 0.11.0.pre1

data/app/models/decidim/consultations/abilities/admin/consultation_admin_ability.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Abilities
+      module Admin
+        # Defines the abilities related to user able to administer consultations.
+        # Intended to be used with `cancancan`.
+        class ConsultationAdminAbility
+          include CanCan::Ability
+
+          attr_reader :user, :context
+
+          def initialize(user, context)
+            return unless user&.admin?
+
+            @user = user
+            @context = context
+
+            can :manage, Consultation
+
+            cannot :publish_results, Consultation
+            can :publish_results, Consultation do |consultation|
+              consultation.finished? && !consultation.results_published?
+            end
+
+            cannot :unpublish_results, Consultation
+            can :unpublish_results, Consultation, &:results_published?
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/consultations/abilities/admin/question_admin_ability.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Abilities
+      module Admin
+        # Defines the abilities related to user able to administer consultation's questions.
+        # Intended to be used with `cancancan`.
+        class QuestionAdminAbility
+          include CanCan::Ability
+
+          attr_reader :user, :context
+
+          def initialize(user, context)
+            return unless user&.admin?
+
+            @user = user
+            @context = context
+
+            can :manage, Question
+            cannot :publish, Question
+            can :publish, Question do |question|
+              question.external_voting || question.responses_count.positive?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/consultations/abilities/admin/response_admin_ability.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Abilities
+      module Admin
+        # Defines the abilities related to user able to administer question responses.
+        # Intended to be used with `cancancan`.
+        class ResponseAdminAbility
+          include CanCan::Ability
+
+          attr_reader :user, :context
+
+          def initialize(user, context)
+            return unless user&.admin?
+
+            @user = user
+            @context = context
+
+            can :manage, Response
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Abilities
+      # Defines the base abilities related to consultations and questions for
+      # authenticated users. Intended to be used with `cancancan`.
+      class CurrentUserAbility < Decidim::Abilities::EveryoneAbility
+        attr_reader :user
+
+        def initialize(user, context)
+          super(user, context)
+          return unless user
+
+          @user = user
+
+          can :vote, Question do |question|
+            can_vote?(question)
+          end
+
+          can :unvote, Question do |question|
+            can_unvote?(question)
+          end
+        end
+
+        private
+
+        def can_vote?(question)
+          question.organization.id == user.organization.id &&
+            question.consultation.active? &&
+            question.consultation.published? &&
+            question.published? &&
+            !question.voted_by?(user)
+        end
+
+        def can_unvote?(question)
+          question.consultation.active? &&
+            question.consultation.published? &&
+            question.published? &&
+            question.voted_by?(user)
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/consultations/abilities/everyone_ability.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Abilities
+      # Defines the base abilities related to consultations for any user. Guest
+      # users will use these too. Intended to be used with `cancancan`.
+      class EveryoneAbility < Decidim::Abilities::EveryoneAbility
+        def initialize(user, context)
+          super(user, context)
+
+          can :read, Consultation do |consultation|
+            consultation.published? || user&.admin?
+          end
+
+          can :read, Question do |question|
+            question.published? || user&.admin?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/consultations/question.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # The data store for Consultation questions in the Decidim::Consultations component.
+    class Question < ApplicationRecord
+      include Decidim::Participable
+      include Decidim::Publicable
+      include Decidim::Scopable
+      include Decidim::Comments::Commentable
+      include Decidim::Followable
+      include Decidim::HasAttachments
+      include Decidim::HasAttachmentCollections
+
+      belongs_to :consultation,
+                 foreign_key: "decidim_consultation_id",
+                 class_name: "Decidim::Consultation",
+                 inverse_of: :questions
+
+      belongs_to :organization,
+                 foreign_key: "decidim_organization_id",
+                 class_name: "Decidim::Organization"
+
+      has_many :components, as: :participatory_space, dependent: :destroy
+      has_many :votes,
+               foreign_key: "decidim_consultation_question_id",
+               class_name: "Decidim::Consultations::Vote",
+               dependent: :destroy,
+               inverse_of: :question
+
+      has_many :responses,
+               foreign_key: "decidim_consultations_questions_id",
+               class_name: "Decidim::Consultations::Response",
+               inverse_of: :question,
+               dependent: :destroy
+
+      has_many :categories,
+               foreign_key: "decidim_participatory_space_id",
+               foreign_type: "decidim_participatory_space_type",
+               dependent: :destroy,
+               as: :participatory_space
+
+      mount_uploader :hero_image, Decidim::HeroImageUploader
+      mount_uploader :banner_image, Decidim::BannerImageUploader
+
+      default_scope { order(order: :asc) }
+
+      delegate :start_voting_date, to: :consultation
+      delegate :end_voting_date, to: :consultation
+      delegate :results_published?, to: :consultation
+
+      # Sorted results for the given question.
+      def sorted_results
+        responses.order(votes_count: :desc)
+      end
+
+      def most_voted_response
+        @most_voted_response ||= responses.order(votes_count: :desc).first
+      end
+
+      def total_votes
+        @total_votes ||= responses.sum(&:votes_count)
+      end
+
+      # Public: Overrides the `comments_have_alignment?` Commentable concern method.
+      def comments_have_alignment?
+        true
+      end
+
+      # Public: Overrides the `comments_have_votes?` Commentable concern method.
+      def comments_have_votes?
+        true
+      end
+
+      def hashtag
+        attributes["hashtag"].to_s.delete("#")
+      end
+
+      def banner_image_url
+        banner_image.present? ? banner_image.url : consultation.banner_image.url
+      end
+
+      # Public: Check if the user has voted the question.
+      #
+      # Returns Boolean.
+      def voted_by?(user)
+        votes.where(author: user).any?
+      end
+
+      def scopes_enabled?
+        false
+      end
+
+      def scopes_enabled
+        false
+      end
+
+      def to_param
+        slug
+      end
+
+      # Overrides module name from participable concern
+      def module_name
+        "Decidim::Consultations"
+      end
+
+      def mounted_engine
+        "decidim_consultations"
+      end
+
+      def mounted_admin_engine
+        "decidim_admin_consultations"
+      end
+
+      def self.participatory_space_manifest
+        Decidim.find_participatory_space_manifest(Decidim::Consultation.name.demodulize.underscore.pluralize)
+      end
+
+      def self.order_randomly(seed)
+        transaction do
+          connection.execute("SELECT setseed(#{connection.quote(seed)})")
+          select('"decidim_consultations_questions".*, RANDOM()').order("RANDOM()").load
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/consultations/response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class Response < ApplicationRecord
+      belongs_to :question,
+                 foreign_key: "decidim_consultations_questions_id",
+                 class_name: "Decidim::Consultations::Question",
+                 counter_cache: :responses_count,
+                 inverse_of: :responses
+
+      has_many :votes,
+               foreign_key: "decidim_consultations_response_id",
+               class_name: "Decidim::Consultations::Vote",
+               inverse_of: :response,
+               dependent: :restrict_with_error
+    end
+  end
+end

data/app/models/decidim/consultations/vote.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # The data store for question's votes in the Decidim::Consultations component.
+    class Vote < ApplicationRecord
+      include Authorable
+
+      belongs_to :question,
+                 foreign_key: "decidim_consultation_question_id",
+                 class_name: "Decidim::Consultations::Question",
+                 counter_cache: :votes_count,
+                 inverse_of: :votes
+
+      belongs_to :response,
+                 foreign_key: "decidim_consultations_response_id",
+                 class_name: "Decidim::Consultations::Response",
+                 inverse_of: :votes,
+                 counter_cache: :votes_count
+
+      validates :author, uniqueness: { scope: [:decidim_user_group_id, :question] }
+
+      delegate :organization, to: :question
+    end
+  end
+end

data/app/presenters/decidim/consultations/question_stats_presenter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # A presenter to render statistics in the homepage.
+    class QuestionStatsPresenter < Rectify::Presenter
+      attribute :question, Decidim::Consultations::Question
+
+      def supports_count
+        question.votes_count
+      end
+
+      def comments_count
+        Rails.cache.fetch(
+          "question/#{question.id}/comments_count",
+          expires_in: Decidim::Consultations.stats_cache_expiration_time
+        ) do
+          Decidim::Comments::Comment.where(root_commentable: question).count
+        end
+      end
+
+      def meetings_count
+        Rails.cache.fetch(
+          "question/#{question.id}/meetings_count",
+          expires_in: Decidim::Consultations.stats_cache_expiration_time
+        ) do
+          Decidim::Meetings::Meeting.where(component: meetings_component).count
+        end
+      end
+
+      def assistants_count
+        Rails.cache.fetch(
+          "question/#{question.id}/assistants_count",
+          expires_in: Decidim::Consultations.stats_cache_expiration_time
+        ) do
+          result = 0
+          Decidim::Meetings::Meeting.where(component: meetings_component).each do |meeting|
+            result += meeting.attendees_count || 0
+          end
+
+          result
+        end
+      end
+
+      private
+
+      def meetings_component
+        @meetings_component ||= Decidim::Component.find_by(participatory_space: question, manifest_name: "meetings")
+      end
+    end
+  end
+end

data/app/queries/decidim/consultations/admin/admin_users.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A class used to find the admins for a participatory process including
+      # organization admins.
+      class AdminUsers < Rectify::Query
+        # Syntactic sugar to initialize the class and return the queried objects.
+        #
+        # consultation - a process that needs to find its process admins
+        def self.for(consultation)
+          new(consultation).query
+        end
+
+        # Initializes the class.
+        #
+        # consultation - a consultation that needs to find its process admins
+        def initialize(consultation)
+          @consultation = consultation
+        end
+
+        # Finds organization admins and the users with role admin for the given process.
+        #
+        # Returns an ActiveRecord::Relation.
+        def query
+          Decidim::User.where(id: organization_admins)
+        end
+
+        private
+
+        attr_reader :consultation
+
+        def organization_admins
+          consultation.organization.admins
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/consultations/organization_active_consultations.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This query class filters all consultations given an organization.
+    class OrganizationActiveConsultations < Rectify::Query
+      def self.for(organization)
+        new(organization).query
+      end
+
+      def initialize(organization)
+        @organization = organization
+      end
+
+      def query
+        Decidim::Consultation.where(organization: @organization).active
+      end
+    end
+  end
+end