decidim-proposals 0.9.3 → 0.10.0

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    class SettingsChangeJob < ApplicationJob
+      def perform(feature_id, previous_settings, current_settings)
+        feature = Decidim::Feature.find(feature_id)
+
+        if creation_enabled?(previous_settings, current_settings)
+          event = "decidim.events.proposals.creation_enabled"
+          event_class = Decidim::Proposals::CreationEnabledEvent
+        elsif voting_enabled?(previous_settings, current_settings)
+          event = "decidim.events.proposals.voting_enabled"
+          event_class = Decidim::Proposals::VotingEnabledEvent
+        elsif endorsing_enabled?(previous_settings, current_settings)
+          event = "decidim.events.proposals.endorsing_enabled"
+          event_class = Decidim::Proposals::EndorsingEnabledEvent
+        end
+
+        return unless event && event_class
+
+        Decidim::EventsManager.publish(
+          event: event,
+          event_class: event_class,
+          resource: feature,
+          recipient_ids: feature.participatory_space.followers.pluck(:id)
+        )
+      end
+
+      private
+
+      def creation_enabled?(previous_settings, current_settings)
+        current_settings[:creation_enabled] == true &&
+          previous_settings[:creation_enabled] == false
+      end
+
+      def voting_enabled?(previous_settings, current_settings)
+        (current_settings[:votes_enabled] == true && current_settings[:votes_blocked] == false) &&
+          (previous_settings[:votes_enabled] == false || previous_settings[:votes_blocked] == true)
+      end
+
+      def endorsing_enabled?(previous_settings, current_settings)
+        (current_settings[:endorsements_enabled] == true && current_settings[:endorsements_blocked] == false) &&
+          (previous_settings[:endorsements_enabled] == false || previous_settings[:endorsements_blocked] == true)
+      end
+    end
+  end
+end

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

@@ -16,14 +16,8 @@ module Decidim
           @user = user
           @context = context
 
-          can :vote, Proposal do |_proposal|
-            authorized?(:vote) && voting_enabled? && remaining_votes.positive?
-          end
-
-          can :unvote, Proposal do |_proposal|
-            authorized?(:vote) && voting_enabled?
-          end
-
+          setup_endorsement_related_abilities
+          setup_voting_related_abilities
           can :create, Proposal if authorized?(:create) && creation_enabled?
           can :edit, Proposal do |proposal|
             proposal.editable_by?(user)
@@ -38,6 +32,24 @@ module Decidim
 
         private
 
+        def setup_endorsement_related_abilities
+          can :endorse, Proposal do |_proposal|
+            authorized?(:endorse) && endorsements_enabled? && !endorsements_blocked?
+          end
+          can :unendorse, Proposal do |_proposal|
+            authorized?(:unendorse) && endorsements_enabled?
+          end
+        end
+
+        def setup_voting_related_abilities
+          can :vote, Proposal do |_proposal|
+            authorized?(:vote) && voting_enabled? && remaining_votes.positive?
+          end
+          can :unvote, Proposal do |_proposal|
+            authorized?(:vote) && voting_enabled?
+          end
+        end
+
         def authorized?(action)
           return unless feature
 
@@ -62,6 +74,16 @@ module Decidim
           feature_settings.vote_limit - votes_count
         end
 
+        def endorsements_enabled?
+          return unless current_settings
+          current_settings.endorsements_enabled?
+        end
+
+        def endorsements_blocked?
+          return unless current_settings
+          current_settings.endorsements_blocked?
+        end
+
         def voting_enabled?
           return unless current_settings
           current_settings.votes_enabled? && !current_settings.votes_blocked?

data/app/models/decidim/proposals/proposal.rb

@@ -7,16 +7,19 @@ module Decidim
       include Decidim::Resourceable
       include Decidim::Authorable
       include Decidim::HasFeature
-      include Decidim::HasScope
+      include Decidim::ScopableFeature
       include Decidim::HasReference
       include Decidim::HasCategory
       include Decidim::Reportable
       include Decidim::HasAttachments
       include Decidim::Followable
-      include Decidim::Comments::Commentable
+      include Decidim::Proposals::CommentableProposal
+      include Decidim::Traceable
+      include Decidim::Loggable
 
       feature_manifest_name "proposals"
 
+      has_many :endorsements, foreign_key: "decidim_proposal_id", class_name: "ProposalEndorsement", dependent: :destroy, counter_cache: "proposal_endorsements_count"
       has_many :votes, foreign_key: "decidim_proposal_id", class_name: "ProposalVote", dependent: :destroy, counter_cache: "proposal_votes_count"
       has_many :notes, foreign_key: "decidim_proposal_id", class_name: "ProposalNote", dependent: :destroy, counter_cache: "proposal_notes_count"
 
@@ -29,6 +32,7 @@ module Decidim
       scope :evaluating, -> { where(state: "evaluating") }
       scope :withdrawn, -> { where(state: "withdrawn") }
       scope :except_withdrawn, -> { where.not(state: "withdrawn").or(where(state: nil)) }
+      scope :published, -> { where.not(published_at: nil) }
 
       def self.order_randomly(seed)
         transaction do
@@ -37,6 +41,10 @@ module Decidim
         end
       end
 
+      def self.log_presenter_class_for(_log)
+        Decidim::Proposals::AdminLog::ProposalPresenter
+      end
+
       # Public: Check if the user has voted the proposal.
       #
       # Returns Boolean.
@@ -44,6 +52,14 @@ module Decidim
         votes.where(author: user).any?
       end
 
+      # Public: Check if the user has endorsed the proposal.
+      # - user_group: may be nil if user is not representing any user_group.
+      #
+      # Returns Boolean.
+      def endorsed_by?(user, user_group = nil)
+        endorsements.where(author: user, user_group: user_group).any?
+      end
+
       # Public: Checks if the organization has given an answer for the proposal.
       #
       # Returns Boolean.
@@ -79,32 +95,6 @@ module Decidim
         state == "withdrawn"
       end
 
-      # Public: Overrides the `commentable?` Commentable concern method.
-      def commentable?
-        feature.settings.comments_enabled?
-      end
-
-      # Public: Overrides the `accepts_new_comments?` Commentable concern method.
-      def accepts_new_comments?
-        commentable? && !feature.current_settings.comments_blocked
-      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
-
-      # Public: Override Commentable concern method `users_to_notify_on_comment_created`
-      def users_to_notify_on_comment_created
-        return (followers | feature.participatory_space.admins).uniq if official?
-        followers
-      end
-
       # Public: Overrides the `reported_content_url` Reportable concern method.
       def reported_content_url
         ResourceLocatorPresenter.new(self).url
@@ -119,7 +109,7 @@ module Decidim
       #
       # Returns an Integer with the maximum amount of votes, nil otherwise.
       def maximum_votes
-        maximum_votes = feature.settings.maximum_votes_per_proposal
+        maximum_votes = feature.settings.threshold_per_proposal
         return nil if maximum_votes.zero?
 
         maximum_votes
@@ -134,26 +124,31 @@ module Decidim
         votes.count >= maximum_votes
       end
 
-      # Checks whether the user is author of the given proposal, either directly
-      # authoring it or via a user group.
+      # Public: Can accumulate more votres than maximum for this proposal.
       #
-      # user - the user to check for authorship
-      def authored_by?(user)
-        author == user || user.user_groups.include?(user_group)
+      # Returns true if can accumulate, false otherwise
+      def can_accumulate_supports_beyond_threshold
+        feature.settings.can_accumulate_supports_beyond_threshold
       end
 
       # Checks whether the user can edit the given proposal.
       #
       # user - the user to check for authorship
       def editable_by?(user)
-        authored_by?(user) && !answered? && within_edit_time_limit?
+        return true if draft?
+        authored_by?(user) && !answered? && within_edit_time_limit? && !copied_from_other_component?
       end
 
       # Checks whether the user can withdraw the given proposal.
       #
       # user - the user to check for withdrawability.
       def withdrawable_by?(user)
-        user && !withdrawn? && authored_by?(user)
+        user && !withdrawn? && authored_by?(user) && !copied_from_other_component?
+      end
+
+      # Public: Whether the proposal is a draft or not.
+      def draft?
+        published_at.nil?
       end
 
       # method for sort_link by number of comments
@@ -171,11 +166,16 @@ module Decidim
 
       private
 
-      # Checks whether the proposal is inside the time window to be editable or not.
+      # Checks whether the proposal is inside the time window to be editable or not once published.
       def within_edit_time_limit?
-        limit = created_at + feature.settings.proposal_edit_before_minutes.minutes
+        return true if draft?
+        limit = updated_at + feature.settings.proposal_edit_before_minutes.minutes
         Time.current < limit
       end
+
+      def copied_from_other_component?
+        linked_resources(:proposals, "copied_from_component").any?
+      end
     end
   end
 end

data/app/models/decidim/proposals/proposal_endorsement.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # A proposal can include an endorsement per user or group.
+    class ProposalEndorsement < ApplicationRecord
+      belongs_to :proposal, foreign_key: "decidim_proposal_id", class_name: "Decidim::Proposals::Proposal", counter_cache: true
+      belongs_to :author, 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
+
+      validates :proposal, uniqueness: { scope: [:author, :user_group] }
+      validate :author_and_proposal_same_organization
+      validate :proposal_not_rejected
+
+      scope :for_listing, -> { order(:decidim_user_group_id, :created_at) }
+
+      private
+
+      # Private: check if the proposal and the author have the same organization
+      def author_and_proposal_same_organization
+        return if !proposal || !author
+        errors.add(:proposal, :invalid) unless author.organization == proposal.organization
+      end
+
+      def proposal_not_rejected
+        return unless proposal
+        errors.add(:proposal, :invalid) if proposal.rejected?
+      end
+    end
+  end
+end

data/app/models/decidim/proposals/proposal_note.rb

@@ -4,10 +4,17 @@ module Decidim
   module Proposals
     # A proposal can include a notes created by admins.
     class ProposalNote < ApplicationRecord
+      include Decidim::Traceable
+      include Decidim::Loggable
+
       belongs_to :proposal, foreign_key: "decidim_proposal_id", class_name: "Decidim::Proposals::Proposal", counter_cache: true
       belongs_to :author, foreign_key: "decidim_author_id", class_name: "Decidim::User"
 
       default_scope { order(created_at: :asc) }
+
+      def self.log_presenter_class_for(_log)
+        Decidim::Proposals::AdminLog::ProposalNotePresenter
+      end
     end
   end
 end

data/app/presenters/decidim/proposals/admin_log/proposal_note_presenter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Proposals::ProposalNote`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    ProposalNotePresenter.new(action_log, view_helpers).present
+      class ProposalNotePresenter < Decidim::Log::BasePresenter
+        private
+
+        def diff_fields_mapping
+          {
+            body: :string
+          }
+        end
+
+        def action_string
+          case action
+          when "create"
+            "decidim.proposals.admin_log.proposal_note.#{action}"
+          else
+            super
+          end
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.proposal_note"
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/proposals/admin_log/proposal_presenter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Proposals::Proposal`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    ProposalPresenter.new(action_log, view_helpers).present
+      class ProposalPresenter < Decidim::Log::BasePresenter
+        private
+
+        def diff_fields_mapping
+          {
+            title: :string,
+            body: :string,
+            state: "Decidim::Proposals::AdminLog::ValueTypes::ProposalStatePresenter",
+            answered_at: :date,
+            answer: :i18n
+          }
+        end
+
+        def action_string
+          case action
+          when "answer", "create"
+            "decidim.proposals.admin_log.proposal.#{action}"
+          else
+            super
+          end
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.proposal"
+        end
+
+        def has_diff?
+          action == "answer" || super
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/proposals/admin_log/value_types/proposal_state_presenter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module AdminLog
+      module ValueTypes
+        class ProposalStatePresenter < Decidim::Log::ValueTypes::DefaultPresenter
+          def present
+            return unless value
+            h.t(value, scope: "decidim.proposals.admin.proposal_answers.edit", default: value)
+          end
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/proposals/similar_proposals.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # Class used to retrieve similar proposals.
+    class SimilarProposals < Rectify::Query
+      include Decidim::TranslationsHelper
+
+      # Syntactic sugar to initialize the class and return the queried objects.
+      #
+      # features - Decidim::CurrentFeature
+      # proposal - Decidim::Proposals::Proposal
+      def self.for(features, proposal)
+        new(features, proposal).query
+      end
+
+      # Initializes the class.
+      #
+      # features - Decidim::CurrentFeature
+      # proposal - Decidim::Proposals::Proposal
+      def initialize(features, proposal)
+        @features = features
+        @proposal = proposal
+      end
+
+      # Retrieves similar proposals
+      def query
+        Decidim::Proposals::Proposal
+          .where(feature: @features)
+          .published
+          .where(
+            "GREATEST(#{title_similarity}, #{body_similarity}) >= ?",
+            proposal.title,
+            proposal.body,
+            Decidim::Proposals.similarity_threshold
+          )
+          .limit(Decidim::Proposals.similarity_limit)
+      end
+
+      private
+
+      attr_reader :proposal
+
+      def title_similarity
+        "similarity(title, ?)"
+      end
+
+      def body_similarity
+        "similarity(body, ?)"
+      end
+    end
+  end
+end