decidim-proposals 0.31.6 → 0.32.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f885c60dad4625728a498f01b934fef5e17db6e67c2b32b090f993959600102
-  data.tar.gz: 5ff2cca8bd53d5f13de93fa1b6d1a6498c968935cfaa1babecb1e7e475d92dce
+  metadata.gz: e42a3076ac40dede627a7f03d7aaad459a2b0caf0164c2df9fdcac1aa50101b8
+  data.tar.gz: b3648c993a746a2e530fd2ee2bf766392a45a16ebdd56b5f336ffe4fed1116aa
 SHA512:
-  metadata.gz: 84932a4f8c33981816817c176b496333be80d48910226140a68b6adf546378a77387b2960a2ff87ca55cd476aa067dd38393899c93b11bbbdf0e612c19720276
-  data.tar.gz: 56d53ba84ec61b93635566d7436b16e496638ad4cc90727cdf17b66abfcc14640c2042dbd749d804e55ea0f10e957452d6879862764fbcb47dda8398187756fb
+  metadata.gz: 8651a09e209979a5eaca293fb56dc5c33eba17bf38393edb10deeddccf82b58fec4ad43eb2c0bf3f466dd7010f24a42c043751044673590140a0b5fe22055b69
+  data.tar.gz: cd789df1ac62a3b52d3278e3a55e0cca8bf8375351cf5f6ac5a897f6f0e2582c29780754b738849e8eeb16e37303831762a2678817d251205fe6d5696a72286c

data/README.md

@@ -1,24 +1,14 @@
-# Decidim::Proposals
+# decidim-proposals
 
-The Proposals module adds one of the main components of Decidim: allows users to contribute to a participatory process by creating proposals.
+The Proposals module adds one of the main components of Decidim: allows users to contribute to a participatory space by creating proposals.
 
 ## Usage
 
-Proposals will be available as a Component for a Participatory Process.
+Proposals will be available as a Component for a Participatory Space.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'decidim-proposals'
-```
-
-And then execute:
-
-```bash
-bundle
-```
+This is on the default Decidim installation so you should not change anything to use this component.
 
 ## Global Search
 

data/app/cells/decidim/proposals/proposal_vote/show.erb

@@ -1,4 +1,19 @@
-<%= cell("decidim/proposals/proposal_votes_count", resource, from_proposals_list:) %>
+<% if !current_settings.votes_hidden? && (current_component.participatory_space.can_participate?(current_user) || current_user&.admin?) %>
+  <% if component_settings.participatory_texts_enabled? && from_proposals_list %>
+    <%= render partial: "decidim/proposals/proposals/participatory_texts/proposal_votes_count", locals: { proposal: resource, from_proposals_list: true } %>
+  <% else %>
+    <% progress ||= resource.proposal_votes_count || 0 %>
+    <% total ||= resource.maximum_votes || 0 %>
+    <%= cell(
+          "decidim/progress_bar",
+          progress,
+          total:,
+          units_name: "decidim.proposals.proposals.votes_count.count",
+          element_id: "proposal-#{resource.id}-votes-count",
+          class: total.positive? ? "card__proposals-votes-limited" : "card__proposals-votes-unlimited"
+        ) %>
+  <% end %>
+<% end %>
 
 <% button_classes = "button button__sm button__secondary w-full" %>
 

data/app/commands/decidim/proposals/admin/merge_proposals.rb

@@ -7,6 +7,7 @@ module Decidim
       # one component to another.
       class MergeProposals < Decidim::Command
         include ::Decidim::MultipleAttachmentsMethods
+
         # Public: Initializes the command.
         #
         # form - A form object with the params.

data/app/commands/decidim/proposals/admin/notify_proposal_answer.rb

@@ -27,6 +27,7 @@ module Decidim
             transaction do
               increment_score
               notify_followers
+              notify_authors
             end
           end
 
@@ -48,11 +49,22 @@ module Decidim
             event: "decidim.events.proposals.proposal_state_changed",
             event_class: Decidim::Proposals::ProposalStateChangedEvent,
             resource: proposal,
-            affected_users: proposal.notifiable_identities,
             followers: proposal.followers - proposal.notifiable_identities
           )
         end
 
+        def notify_authors
+          return if proposal.state == "not_answered"
+
+          Decidim::EventsManager.publish(
+            event: "decidim.events.proposals.proposal_state_changed_for_authors",
+            event_class: Decidim::Proposals::ProposalStateChangedEvent,
+            resource: proposal,
+            affected_users: proposal.authors,
+            extra: { force_email: true }
+          )
+        end
+
         def increment_score
           if proposal.accepted?
             proposal.coauthorships.find_each do |coauthorship|

data/app/commands/decidim/proposals/admin/update_proposal.rb

@@ -36,7 +36,7 @@ module Decidim
           transaction do
             update_proposal
             update_proposal_author
-            attachment_cleanup!(include_all_attachments: true)
+            document_cleanup!(include_all_attachments: true)
             create_attachments(first_weight: first_attachment_weight) if process_attachments?
           end
 

data/app/commands/decidim/proposals/admin/update_proposal_taxonomies.rb

@@ -6,6 +6,7 @@ module Decidim
       #  A command with all the business logic when an admin batch updates proposals taxonomies.
       class UpdateProposalTaxonomies < UpdateResourcesTaxonomies
         include TranslatableAttributes
+
         # Public: Initializes the command.
         #
         # taxonomy_ids - the taxonomy ids to update

data/app/commands/decidim/proposals/create_proposal.rb

@@ -82,7 +82,7 @@ module Decidim
             )
 
             proposal.taxonomizations = form.taxonomizations if form.taxonomizations.present?
-            proposal.attachments = form.attachments if form.attachments.present?
+            proposal.documents = form.documents if form.documents.present?
             if form.geocoded?
               proposal.latitude = form.latitude
               proposal.longitude = form.longitude

data/app/commands/decidim/proposals/gallery_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # A module with all the gallery common methods for proposals commands.
+    # Allows to create several image attachments at once
+    module GalleryMethods
+      include ::Decidim::GalleryMethods
+
+      private
+
+      def gallery_allowed?
+        @form.current_component.settings.attachments_allowed?
+      end
+    end
+  end
+end

data/app/commands/decidim/proposals/unvote_proposal.rb

@@ -16,7 +16,6 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid, together with the proposal.
-      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

data/app/commands/decidim/proposals/update_proposal.rb

@@ -39,7 +39,7 @@ module Decidim
             update_proposal
           end
 
-          attachment_cleanup!(include_all_attachments: true)
+          document_cleanup!(include_all_attachments: true)
 
           create_attachments(first_weight: first_attachment_weight) if process_attachments?
         end

data/app/controllers/concerns/decidim/proposals/admin/filterable.rb

@@ -32,10 +32,6 @@ module Decidim
             collection.with_evaluation_assigned_to(current_user, current_participatory_space)
           end
 
-          def search_field_predicate
-            :id_string_or_title_cont
-          end
-
           def filter_config
             @filter_config ||= Decidim::AdminFilter.new(:proposals).build_for(self)
           end

data/app/controllers/concerns/decidim/proposals/orderable.rb

@@ -22,9 +22,10 @@ module Decidim
           @possible_orders ||= begin
             possible_orders = %w(random recent)
             possible_orders << "most_voted" if most_voted_order_available?
-            possible_orders << "most_liked" if current_settings.likes_enabled?
-            possible_orders << "most_commented" if component_settings.comments_enabled?
-            possible_orders << "most_followed" << "with_more_authors"
+            possible_orders << "most_liked" if most_liked_order_available?
+            possible_orders << "most_commented" if most_commented_order_available?
+            possible_orders << "most_followed" # always shown, as the author automatically follows their proposals
+            possible_orders << "with_more_authors" if with_more_authors_order_available?
             possible_orders
           end
         end
@@ -52,6 +53,24 @@ module Decidim
           current_settings.votes_enabled? && !current_settings.votes_hidden?
         end
 
+        def with_more_authors_order_available?
+          return @with_more_authors_order_available if defined?(@with_more_authors_order_available)
+
+          @with_more_authors_order_available = Decidim::Proposals::Proposal.with_more_authors_available?(current_component)
+        end
+
+        def most_commented_order_available?
+          return @most_commented_order_available if defined?(@most_commented_order_available)
+
+          @most_commented_order_available = Decidim::Proposals::Proposal.most_commented_available?(current_component)
+        end
+
+        def most_liked_order_available?
+          return @most_liked_order_available if defined?(@most_liked_order_available)
+
+          @most_liked_order_available = Decidim::Proposals::Proposal.most_liked_available?(current_component)
+        end
+
         def order_by_votes?
           most_voted_order_available? && current_settings.votes_blocked?
         end

data/app/controllers/decidim/proposals/admin/evaluation_assignments_controller.rb

@@ -34,12 +34,12 @@ module Decidim
           Admin::UnassignProposalsFromEvaluator.call(@form) do
             on(:ok) do |_proposal|
               flash.keep[:notice] = I18n.t("evaluation_assignments.delete.success", scope: "decidim.proposals.admin")
-              redirect_back fallback_location: EngineRouter.admin_proxy(current_component).root_path
+              redirect_back_or_to(EngineRouter.admin_proxy(current_component).root_path)
             end
 
             on(:invalid) do
               flash.keep[:alert] = I18n.t("evaluation_assignments.delete.invalid", scope: "decidim.proposals.admin")
-              redirect_back fallback_location: EngineRouter.admin_proxy(current_component).root_path
+              redirect_back_or_to(EngineRouter.admin_proxy(current_component).root_path)
             end
           end
         end

data/app/controllers/decidim/proposals/admin/participatory_texts_controller.rb

@@ -32,12 +32,12 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("participatory_texts.import.invalid", scope: "decidim.proposals.admin")
-              render action: "new_import", status: :unprocessable_entity
+              render action: "new_import", status: :unprocessable_content
             end
 
             on(:invalid_file) do
               flash.now[:alert] = I18n.t("participatory_texts.import.invalid_file", scope: "decidim.proposals.admin")
-              render action: "new_import", status: :unprocessable_entity
+              render action: "new_import", status: :unprocessable_content
             end
           end
         end
@@ -62,7 +62,7 @@ module Decidim
                 failures.each_pair { |id, msg| alert_msg << "ID:[#{id}] #{msg}" }
                 flash.now[:alert] = alert_msg.join("<br/>").html_safe
                 index
-                render action: "index", status: :unprocessable_entity
+                render action: "index", status: :unprocessable_content
               end
             end
           else
@@ -77,7 +77,7 @@ module Decidim
                 failures.each_pair { |id, msg| alert_msg << "ID:[#{id}] #{msg}" }
                 flash.now[:alert] = alert_msg.join("<br/>").html_safe
                 index
-                render action: "index", status: :unprocessable_entity
+                render action: "index", status: :unprocessable_content
               end
             end
           end

data/app/controllers/decidim/proposals/admin/proposal_answers_controller.rb

@@ -34,7 +34,7 @@ module Decidim
 
             on(:invalid) do
               flash.keep[:alert] = I18n.t("proposals.answer.invalid", scope: "decidim.proposals.admin")
-              render template: "decidim/proposals/admin/proposals/show", status: :unprocessable_entity
+              render template: "decidim/proposals/admin/proposals/show", status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/proposals/admin/proposal_states_controller.rb

@@ -30,7 +30,7 @@ module Decidim
             on(:invalid) do
               flash.keep[:alert] = I18n.t("proposal_states.create.error", scope: "decidim.proposals.admin")
 
-              render action: :new, status: :unprocessable_entity
+              render action: :new, status: :unprocessable_content
             end
           end
         end
@@ -54,7 +54,7 @@ module Decidim
             on(:invalid) do
               flash.now[:alert] = I18n.t("proposal_states.update.error", scope: "decidim.proposals.admin")
 
-              render action: :edit, status: :unprocessable_entity
+              render action: :edit, status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/proposals/admin/proposals_controller.rb

@@ -44,7 +44,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("proposals.create.invalid", scope: "decidim.proposals.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end
@@ -129,7 +129,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = t("proposals.update.error", scope: "decidim")
-              render :edit, status: :unprocessable_entity
+              render :edit, status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/proposals/admin/proposals_imports_controller.rb

@@ -23,7 +23,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("proposals_imports.create.invalid", scope: "decidim.proposals.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/proposals/admin/proposals_merges_controller.rb

@@ -29,7 +29,7 @@ module Decidim
                 I18n.t("proposals_merges.create.invalid", scope: "decidim.proposals.admin"),
                 @form
               ).message
-              render :new, status: :unprocessable_entity
+              render :new, status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/proposals/invite_coauthors_controller.rb

@@ -53,7 +53,7 @@ module Decidim
           end
 
           on(:invalid) do
-            render json: { message: I18n.t("update.error", scope: "decidim.proposals.invite_coauthors") }, status: :unprocessable_entity
+            render json: { message: I18n.t("update.error", scope: "decidim.proposals.invite_coauthors") }, status: :unprocessable_content
           end
         end
       end
@@ -68,7 +68,7 @@ module Decidim
           end
 
           on(:invalid) do
-            render json: { message: I18n.t("destroy.error", scope: "decidim.proposals.invite_coauthors") }, status: :unprocessable_entity
+            render json: { message: I18n.t("destroy.error", scope: "decidim.proposals.invite_coauthors") }, status: :unprocessable_content
           end
         end
       end

data/app/controllers/decidim/proposals/proposal_votes_controller.rb

@@ -29,7 +29,7 @@ module Decidim
           end
 
           on(:invalid) do
-            render json: { error: I18n.t("proposal_votes.create.error", scope: "decidim.proposals") }, status: :unprocessable_entity
+            render json: { error: I18n.t("proposal_votes.create.error", scope: "decidim.proposals") }, status: :unprocessable_content
           end
         end
       end

data/app/controllers/decidim/proposals/proposals_controller.rb

@@ -20,7 +20,7 @@ module Decidim
 
       before_action :authenticate_user!, only: [:new, :create]
       before_action :ensure_is_draft, only: [:preview, :publish, :edit_draft, :update_draft, :destroy_draft]
-      before_action :set_proposal, only: [:show, :edit, :update, :withdraw]
+      before_action :proposal, only: [:show, :edit, :update, :withdraw]
       before_action :edit_form, only: [:edit_draft, :edit]
       before_action :set_view_mode, only: [:index]
 
@@ -79,7 +79,7 @@ module Decidim
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.create.error", scope: "decidim")
-            render :new, status: :unprocessable_entity
+            render :new, status: :unprocessable_content
           end
         end
       end
@@ -101,7 +101,7 @@ module Decidim
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.publish.error", scope: "decidim")
-            render :edit_draft, status: :unprocessable_entity
+            render :edit_draft, status: :unprocessable_content
           end
         end
       end
@@ -124,7 +124,7 @@ module Decidim
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.update_draft.error", scope: "decidim")
-            render :edit_draft, status: :unprocessable_entity
+            render :edit_draft, status: :unprocessable_content
           end
         end
       end
@@ -140,7 +140,7 @@ module Decidim
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.destroy_draft.error", scope: "decidim")
-            render :edit_draft, status: :unprocessable_entity
+            render :edit_draft, status: :unprocessable_content
           end
         end
       end
@@ -161,7 +161,7 @@ module Decidim
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.update.error", scope: "decidim")
-            render :edit, status: :unprocessable_entity
+            render :edit, status: :unprocessable_content
           end
         end
       end
@@ -216,8 +216,8 @@ module Decidim
         redirect_to Decidim::ResourceLocatorPresenter.new(@proposal).path unless @proposal.draft?
       end
 
-      def set_proposal
-        @proposal = Proposal.published.not_hidden.where(component: current_component).find_by(id: params[:id])
+      def proposal
+        @proposal ||= Proposal.published.not_hidden.where(component: current_component).find_by(id: params[:id])
       end
 
       # Returns true if the proposal is NOT an emendation or the user IS an admin.
@@ -295,6 +295,28 @@ module Decidim
       def default_view_mode
         @default_view_mode ||= current_component.settings.attachments_allowed? ? "grid" : "list"
       end
+
+      def add_parent_breadcrumb_item
+        return {} if proposal.blank?
+
+        object = proposal.emendation? ? proposal.amendable : proposal
+        {
+          label: translated_attribute(object.title),
+          url: Decidim::EngineRouter.main_proxy(current_component).proposal_path(object),
+          active: false
+        }
+      end
+
+      def add_breadcrumb_item
+        return {} if proposal.blank?
+        return {} if proposal.amendable?
+
+        {
+          label: I18n.t("decidim.amendments.name"),
+          url: Decidim::EngineRouter.main_proxy(current_component).proposal_path(proposal),
+          active: false
+        }
+      end
     end
   end
 end

data/app/controllers/decidim/proposals/versions_controller.rb

@@ -2,19 +2,23 @@
 
 module Decidim
   module Proposals
-    # Exposes Proposals versions so users can see how a Proposal/CollaborativeDraft
-    # has been updated through time.
+    # Exposes Proposals versions so users can see how a Proposal has been updated through time.
     class VersionsController < Decidim::Proposals::ApplicationController
       include Decidim::ApplicationHelper
       include Decidim::ResourceVersionsConcern
 
       def versioned_resource
-        @versioned_resource ||=
-          if params[:proposal_id]
-            present(Proposal.not_hidden.published.where(component: current_component).find(params[:proposal_id]))
-          else
-            CollaborativeDraft.where(component: current_component).find(params[:collaborative_draft_id])
-          end
+        @versioned_resource ||= Proposal.not_hidden.published.where(component: current_component).find(params[:proposal_id])
+      end
+
+      def add_breadcrumb_item
+        return {} if versioned_resource.blank?
+
+        {
+          label: translated_attribute(versioned_resource.title),
+          url: Decidim::EngineRouter.main_proxy(current_component).proposal_path(versioned_resource),
+          active: false
+        }
       end
     end
   end

data/app/events/decidim/proposals/admin/proposal_assigned_to_evaluator_event.rb

@@ -13,7 +13,7 @@ module Decidim
         end
 
         def admin_proposal_info_url
-          send(resource.component.mounted_admin_engine).proposal_url(resource, resource.component.mounted_params)
+          EngineRouter.admin_proxy(resource.component).proposal_url(resource)
         end
 
         private

data/app/events/decidim/proposals/admin/proposal_note_created_event.rb

@@ -14,7 +14,7 @@ module Decidim
         end
 
         def admin_proposal_info_url
-          send(resource.component.mounted_admin_engine).proposal_url(resource, resource.component.mounted_params)
+          EngineRouter.admin_proxy(resource.component).proposal_url(resource)
         end
 
         private

data/app/forms/decidim/proposals/admin/proposal_form.rb

@@ -14,7 +14,7 @@ module Decidim
         translatable_attribute :body, Decidim::Attributes::RichText
         attribute :attachment, AttachmentForm
 
-        attachments_attribute :attachments
+        attachments_attribute :documents
 
         validates :title, :body, translatable_presence: true
         validates :title, :body, translated_etiquette: true
@@ -27,12 +27,61 @@ module Decidim
 
           self.title = presenter.title(all_locales: title.is_a?(Hash))
           self.body = presenter.editor_body(all_locales: body.is_a?(Hash))
-          self.attachments = model.attachments.ids
-          self.add_attachments = model.attachments.map { |att| { id: att.id, title: att.title } }
+          self.documents = model.attachments.ids
+          self.add_documents = model.attachments.map { |att| { id: att.id, title: att.title } }
+        end
+
+        def documents=(value)
+          case value
+          when String
+            super(parse_string_documents(value))
+          when Integer
+            super([value])
+          else
+            super
+          end
+        end
+
+        def documents
+          result = super
+
+          if should_use_add_documents?(result)
+            extract_ids_from_add_documents
+          else
+            result.is_a?(Array) ? result : []
+          end
         end
 
         def notify_missing_attachment_if_errored
-          errors.add(:add_attachments, :needs_to_be_reattached) if errors.any? && add_attachments.present?
+          errors.add(:add_documents, :needs_to_be_reattached) if errors.any? && add_documents.present?
+        end
+
+        private
+
+        def should_use_add_documents?(result)
+          (result.blank? || result.is_a?(String)) && add_documents.present?
+        end
+
+        def extract_ids_from_add_documents
+          add_documents
+            .select { |doc| doc.is_a?(Hash) && (doc[:id].present? || doc["id"].present?) }
+            .map { |doc| (doc[:id] || doc["id"]).to_i }
+        end
+
+        def parse_string_documents(value)
+          return [] if value.blank?
+
+          parse_document_ids(value)
+        end
+
+        def parse_document_ids(value)
+          ids = begin
+            Array(JSON.parse(value))
+          rescue JSON::ParserError
+            value.split(",").map(&:strip)
+          end
+
+          ids.map(&:to_i).reject(&:zero?)
         end
       end
     end

data/app/forms/decidim/proposals/admin/proposals_import_form.rb

@@ -7,6 +7,7 @@ module Decidim
       # from another component.
       class ProposalsImportForm < Decidim::Form
         include TranslatableAttributes
+
         mimic :proposals_import
 
         attribute :origin_component_id, Integer
@@ -15,6 +16,7 @@ module Decidim
         attribute :states, Array[String]
 
         validates :origin_component_id, :origin_component, :current_component, presence: true
+        validates :states, presence: true
         validate :valid_states
 
         def states

data/app/forms/decidim/proposals/admin/proposals_merge_form.rb

@@ -8,6 +8,7 @@ module Decidim
       class ProposalsMergeForm < ProposalBaseForm
         include Decidim::HasUploadValidations
         include Decidim::AttachmentAttributes
+
         translatable_attribute :title, String do |field, _locale|
           validates field, length: { in: 15..150 }, if: proc { |resource| resource.send(field).present? }
         end
@@ -15,7 +16,7 @@ module Decidim
         attribute :target_component_id, Array[Integer]
         attribute :proposal_ids, Array
 
-        attachments_attribute :attachments
+        attachments_attribute :documents
 
         validates :target_component, :proposals, :current_component, presence: true
         validates :proposal_ids, length: { minimum: 2 }
@@ -61,7 +62,7 @@ module Decidim
         end
 
         def notify_missing_attachment_if_errored
-          errors.add(:add_attachments, :needs_to_be_reattached) if errors.any? && add_attachments.present?
+          errors.add(:add_documents, :needs_to_be_reattached) if errors.any? && add_documents.present?
         end
       end
     end