decidim-initiatives 0.22.0 → 0.23.0

data/app/models/decidim/initiative.rb

@@ -7,7 +7,7 @@ module Decidim
     include Decidim::Authorable
     include Decidim::Participable
     include Decidim::Publicable
-    include Decidim::Scopable
+    include Decidim::ScopableParticipatorySpace
     include Decidim::Comments::Commentable
     include Decidim::Followable
     include Decidim::HasAttachments
@@ -20,6 +20,9 @@ module Decidim
     include Decidim::Randomable
     include Decidim::Searchable
     include Decidim::Initiatives::HasArea
+    include Decidim::TranslatableResource
+
+    translatable_fields :title, :description, :answer
 
     belongs_to :organization,
                foreign_key: "decidim_organization_id",
@@ -30,7 +33,7 @@ module Decidim
                class_name: "Decidim::InitiativesTypeScope",
                inverse_of: :initiatives
 
-    delegate :type, :scope, :scope_name, to: :scoped_type, allow_nil: true
+    delegate :type, :scope, :scope_name, :supports_required, to: :scoped_type, allow_nil: true
     delegate :attachments_enabled?, :promoting_committee_enabled?, :custom_signature_end_date_enabled?, :area_enabled?, to: :type
     delegate :name, to: :area, prefix: true, allow_nil: true
 
@@ -61,12 +64,11 @@ module Decidim
 
     validates :title, :description, :state, presence: true
     validates :signature_type, presence: true
-    validate :signature_type_allowed
-
     validates :hashtag,
               uniqueness: true,
               allow_blank: true,
               case_sensitive: false
+    validate :signature_type_allowed
 
     scope :open, lambda {
       where.not(state: [:discarded, :rejected, :accepted, :created])
@@ -94,16 +96,19 @@ module Decidim
     scope :signature_type_updatable, -> { created }
 
     scope :order_by_most_recent, -> { order(created_at: :desc) }
+    scope :order_by_supports, -> { order(Arel.sql("(coalesce((online_votes->>'total')::int,0) + coalesce((offline_votes->>'total')::int,0)) DESC")) }
     scope :order_by_most_recently_published, -> { order(published_at: :desc) }
-    scope :order_by_supports, -> { order(Arel.sql("initiative_votes_count + coalesce(offline_votes, 0) desc")) }
     scope :order_by_most_commented, lambda {
       select("decidim_initiatives.*")
         .left_joins(:comments)
         .group("decidim_initiatives.id")
         .order(Arel.sql("count(decidim_comments_comments.id) desc"))
     }
+    scope :future_spaces, -> { none }
+    scope :past_spaces, -> { closed }
 
-    after_save :notify_state_change
+    before_update :set_offline_votes_total
+    after_commit :notify_state_change
     after_create :notify_creation
 
     searchable_fields({
@@ -116,18 +121,20 @@ module Decidim
                       # is Resourceable instead of ParticipatorySpaceResourceable so we can't use `visible?`
                       index_on_update: ->(initiative) { initiative.published? })
 
-    def self.future_spaces
-      none
-    end
-
-    def self.past_spaces
-      closed
-    end
-
     def self.log_presenter_class_for(_log)
       Decidim::Initiatives::AdminLog::InitiativePresenter
     end
 
+    # PUBLIC banner image
+    #
+    # Overrides participatory space's banner image with the banner image defined
+    # for the initiative type.
+    #
+    # RETURNS string
+    delegate :banner_image, to: :type
+    delegate :document_number_authorization_handler, :promoting_committee_enabled?, to: :type
+    delegate :type, :scope, :scope_name, to: :scoped_type, allow_nil: true
+
     # PUBLIC
     #
     # Returns true when an initiative has been created by an individual person.
@@ -182,17 +189,6 @@ module Decidim
         ActionController::Base.helpers.asset_path("decidim/default-avatar.svg")
     end
 
-    # PUBLIC banner image
-    #
-    # Overrides participatory space's banner image with the banner image defined
-    # for the initiative type.
-    #
-    # RETURNS string
-    delegate :banner_image, to: :type
-
-    delegate :document_number_authorization_handler, to: :type
-    delegate :supports_required, to: :scoped_type
-
     def votes_enabled?
       published? &&
         signature_start_date <= Date.current &&
@@ -241,7 +237,6 @@ module Decidim
       )
     end
 
-    #
     # Public: Unpublishes this initiative
     #
     # Returns true if the record was properly saved, false otherwise.
@@ -261,10 +256,25 @@ module Decidim
       attributes["hashtag"].to_s.delete("#")
     end
 
+    # Public: Calculates the number of total current supports.
+    #
+    # Returns an Integer.
     def supports_count
-      face_to_face_votes = offline_votes.nil? || online_signature_type? ? 0 : offline_votes
-      digital_votes = offline_signature_type? ? 0 : (initiative_votes_count + initiative_supports_count)
-      digital_votes + face_to_face_votes
+      online_votes_count + offline_votes_count
+    end
+
+    # Public: Calculates the number of current supports for a scope.
+    #
+    # Returns an Integer.
+    def supports_count_for(scope)
+      online_votes_count_for(scope) + offline_votes_count_for(scope)
+    end
+
+    # Public: Calculates the number of supports required to accept the initiative for a scope.
+    #
+    # Returns an Integer.
+    def supports_required_for(scope)
+      initiative_type_scopes.find_by(decidim_scopes_id: scope&.id).supports_required
     end
 
     # Public: Returns the percentage of required supports reached
@@ -276,7 +286,75 @@ module Decidim
 
     # Public: Whether the supports required objective has been reached
     def supports_goal_reached?
-      supports_count >= supports_required
+      initiative_type_scopes.map(&:scope).all? { |scope| supports_goal_reached_for?(scope) }
+    end
+
+    # Public: Whether the supports required objective has been reached for a scope
+    def supports_goal_reached_for?(scope)
+      supports_count_for(scope) >= supports_required_for(scope)
+    end
+
+    # Public: Calculates all the votes across all the scopes.
+    #
+    # Returns an Integer.
+    def online_votes_count
+      return 0 if offline_signature_type?
+
+      online_votes["total"].to_i
+    end
+
+    def offline_votes_count
+      return 0 if online_signature_type?
+
+      offline_votes["total"].to_i
+    end
+
+    def online_votes_count_for(scope)
+      return 0 if offline_signature_type?
+
+      scope_key = (scope&.id || "global").to_s
+
+      (online_votes || {}).fetch(scope_key, 0).to_i
+    end
+
+    def offline_votes_count_for(scope)
+      return 0 if online_signature_type?
+
+      scope_key = (scope&.id || "global").to_s
+
+      (offline_votes || {}).fetch(scope_key, 0).to_i
+    end
+
+    def update_online_votes_counters
+      online_votes = votes.group(:scope).count.each_with_object({}) do |(scope, count), counters|
+        counters[scope&.id || "global"] = count
+        counters["total"] ||= 0
+        counters["total"] += count
+      end
+
+      # rubocop:disable Rails/SkipsModelValidations
+      update_column("online_votes", online_votes)
+      # rubocop:enable Rails/SkipsModelValidations
+    end
+
+    def set_offline_votes_total
+      return if offline_votes.blank? || scope.nil?
+
+      offline_votes["total"] = offline_votes[scope.id.to_s]
+    end
+
+    # Public: Finds all the InitiativeTypeScopes that are eligible to be voted by a user.
+    # Usually this is only the `scoped_type` but voting on children of the scoped type is
+    # enabled we have to filter all the available scopes in the initiative type to select
+    # the ones that are a descendant of the initiative type.
+    #
+    # Returns an Array of Decidim::InitiativesScopeType.
+    def votable_initiative_type_scopes
+      return Array(scoped_type) unless type.child_scope_threshold_enabled?
+
+      initiative_type_scopes.select do |initiative_type_scope|
+        initiative_type_scope.scope.present? && (scoped_type.global_scope? || scoped_type.scope.ancestor_of?(initiative_type_scope.scope))
+      end.prepend(scoped_type).uniq
     end
 
     # Public: Overrides slug attribute from participatory processes.
@@ -299,12 +377,10 @@ module Decidim
       true
     end
 
-    # PUBLIC
-    #
-    # Checks if user is the author or is part of the promotal committee
+    # Public:  Checks if user is the author or is part of the promotal committee
     # of the initiative.
     #
-    # RETURNS boolean
+    # Returns a Boolean.
     def has_authorship?(user)
       return true if author.id == user.id
 
@@ -355,6 +431,18 @@ module Decidim
 
     private
 
+    # Private: This is just an alias because the naming on InitiativeTypeScope
+    # is very confusing. The `scopes` method doesn't return Decidim::Scope but
+    # Decidim::InitiativeTypeScopes.
+    #
+    # ¯\_(ツ)_/¯
+    #
+    # Returns an Array of Decidim::InitiativesScopeType.
+    def initiative_type_scopes
+      type.scopes
+    end
+
+    # Private: A validator that verifies the signaature type is allowed by the InitiativeType.
     def signature_type_allowed
       return if published?
 
@@ -389,24 +477,7 @@ module Decidim
 
     # method for sort_link by number of supports
     ransacker :supports_count do
-      query = <<~SQL
-        (
-          SELECT
-            CASE
-              WHEN signature_type = 0 THEN 0
-              ELSE COALESCE(offline_votes, 0)
-            END
-            +
-            CASE
-              WHEN signature_type = 1 THEN 0
-              ELSE initiative_votes_count + initiative_supports_count
-            END
-           FROM decidim_initiatives as initiatives
-          WHERE initiatives.id = decidim_initiatives.id
-          GROUP BY initiatives.id
-        )
-      SQL
-      Arel.sql(query)
+      Arel.sql("(coalesce((online_votes->>'total')::int,0) + coalesce((offline_votes->>'total')::int,0))")
     end
 
     ransacker :id_string do

data/app/models/decidim/initiatives_type.rb

@@ -4,6 +4,9 @@ module Decidim
   # Initiative type.
   class InitiativesType < ApplicationRecord
     include Decidim::HasResourcePermission
+    include Decidim::TranslatableResource
+
+    translatable_fields :title, :description, :extra_fields_legal_information
 
     belongs_to :organization,
                foreign_key: "decidim_organization_id",
@@ -21,8 +24,8 @@ module Decidim
 
     enum signature_type: [:online, :offline, :any], _suffix: true
 
-    validates :signature_type, presence: true
-    validates :title, :description, presence: true
+    validates :title, :description, :signature_type, presence: true
+    validates :document_number_authorization_handler, presence: true, if: ->(form) { form.collect_user_extra_fields? }
 
     mount_uploader :banner_image, Decidim::BannerImageUploader
 

data/app/models/decidim/initiatives_type_scope.rb

@@ -25,8 +25,12 @@ module Decidim
       greater_than: 0
     }
 
+    def global_scope?
+      decidim_scopes_id.nil?
+    end
+
     def scope_name
-      return { I18n.locale.to_s => I18n.t("decidim.scopes.global") } if decidim_scopes_id.nil?
+      return { I18n.locale.to_s => I18n.t("decidim.scopes.global") } if global_scope?
 
       scope&.name.presence || { I18n.locale.to_s => I18n.t("decidim.initiatives.unavailable_scope") }
     end

data/app/models/decidim/initiatives_vote.rb

@@ -11,37 +11,43 @@ module Decidim
                foreign_key: "decidim_author_id",
                class_name: "Decidim::User"
 
-    belongs_to :user_group,
-               foreign_key: "decidim_user_group_id",
-               class_name: "Decidim::UserGroup",
-               optional: true
-
     belongs_to :initiative,
                foreign_key: "decidim_initiative_id",
                class_name: "Decidim::Initiative",
                inverse_of: :votes
 
-    validates :initiative, uniqueness: { scope: [:author, :user_group] }
+    belongs_to :scope,
+               foreign_key: "decidim_scope_id",
+               class_name: "Decidim::Scope",
+               optional: true
+
+    validates :initiative, uniqueness: { scope: [:author, :scope] }
+    validates :initiative, uniqueness: { scope: [:hash_id, :scope] }
 
     after_commit :update_counter_cache, on: [:create, :destroy]
 
-    scope :supports, -> { where.not(decidim_user_group_id: nil) }
-    scope :votes, -> { where(decidim_user_group_id: nil) }
+    scope :for_scope, ->(scope) { where(scope: scope) }
 
-    # PUBLIC
+    # Public: Generates a hashed representation of the initiative support.
     #
-    # Generates a hashed representation of the initiative support.
+    # Used when exporting the votes as CSV.
     def sha1
-      return unless decidim_user_group_id.nil?
-
       title = translated_attribute(initiative.title)
       description = translated_attribute(initiative.description)
 
       Digest::SHA1.hexdigest "#{authorization_unique_id}#{title}#{description}"
     end
 
+    def decrypted_metadata
+      @decrypted_metadata ||= encrypted_metadata ? encryptor.decrypt(encrypted_metadata) : {}
+    end
+
     private
 
+    def encryptor
+      @encryptor ||= Decidim::Initiatives::DataEncryptor.new(secret: "personal user metadata")
+    end
+
     def authorization_unique_id
       first_authorization = Decidim::Initiatives::UserAuthorizations
                             .for(author)
@@ -51,17 +57,7 @@ module Decidim
     end
 
     def update_counter_cache
-      initiative.initiative_votes_count = Decidim::InitiativesVote
-                                          .votes
-                                          .where(decidim_initiative_id: initiative.id)
-                                          .count
-
-      initiative.initiative_supports_count = Decidim::InitiativesVote
-                                             .supports
-                                             .where(decidim_initiative_id: initiative.id)
-                                             .count
-
-      initiative.save
+      initiative.update_online_votes_counters
     end
   end
 end

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

@@ -147,12 +147,12 @@ module Decidim
           when :accept
             allowed = initiative.published? &&
                       initiative.signature_end_date < Date.current &&
-                      initiative.percentage >= 100
+                      initiative.supports_goal_reached?
             toggle_allow(allowed)
           when :reject
             allowed = initiative.published? &&
                       initiative.signature_end_date < Date.current &&
-                      initiative.percentage < 100
+                      !initiative.supports_goal_reached?
             toggle_allow(allowed)
           when :send_to_technical_validation
             toggle_allow(allowed_to_send_to_technical_validation?)

data/app/permissions/decidim/initiatives/permissions.rb

@@ -142,8 +142,7 @@ module Decidim
 
         can_unvote = initiative.accepts_online_unvotes? &&
                      initiative.organization&.id == user.organization&.id &&
-                     initiative.votes.where(decidim_author_id: user.id, decidim_user_group_id: decidim_user_group_id).any? &&
-                     (can_user_support?(initiative) || Decidim::UserGroups::ManageableUserGroups.for(user).verified.any?) &&
+                     initiative.votes.where(author: user).any? &&
                      authorized?(:vote, resource: initiative, permissions_holder: initiative.type)
 
         toggle_allow(can_unvote)
@@ -180,8 +179,7 @@ module Decidim
       def can_vote?
         initiative.votes_enabled? &&
           initiative.organization&.id == user.organization&.id &&
-          initiative.votes.where(decidim_author_id: user.id, decidim_user_group_id: decidim_user_group_id).empty? &&
-          (can_user_support?(initiative) || Decidim::UserGroups::ManageableUserGroups.for(user).verified.any?) &&
+          initiative.votes.where(author: user).empty? &&
           authorized?(:vote, resource: initiative, permissions_holder: initiative.type)
       end
 

data/app/presenters/decidim/initiatives/initiative_stats_presenter.rb

@@ -6,16 +6,12 @@ module Decidim
     class InitiativeStatsPresenter < Rectify::Presenter
       attribute :initiative, Decidim::Initiative
 
-      def supports_count
-        initiative.initiative_supports_count
-      end
-
       def comments_count
         Rails.cache.fetch(
           "initiative/#{initiative.id}/comments_count",
           expires_in: Decidim::Initiatives.stats_cache_expiration_time
         ) do
-          Decidim::Comments::Comment.where(root_commentable: initiative).count
+          initiative.comments_count
         end
       end
 

data/app/views/decidim/initiatives/admin/answers/_info_initiative.html.erb

@@ -17,7 +17,7 @@
       <strong><%= t ".state" %>: </strong> <%= I18n.t(initiative.state, scope: "decidim.initiatives.admin_states") %>
     </div>
     <div class="row column">
-      <strong><%= t ".initiative_votes_count" %>: </strong> <%= initiative.initiative_votes_count %>
+      <strong><%= t ".initiative_votes_count" %>: </strong> <%= initiative.online_votes_count %>
     </div>
   </div>
 </div>