decidim-proposals 0.11.2 → 0.12.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7b361dc23139798e9d1f00b815ba258bf49aa42a73a187ed9da26a205390cdb
-  data.tar.gz: f6091d108a9d62789c6e5dd33955045a8be80845d8d0ba130c3f4ff0c67f67d5
+  metadata.gz: 2384c4b531953a2fd808d55b6d7fbc1fc4af2a4cd2a0f8c0935cd3358201870a
+  data.tar.gz: 83edd0b0d7ee83bc2ae14aef758bb4ab4380342cfc82b32bd7039ecbf5330491
 SHA512:
-  metadata.gz: 62db09b1966e92b7cef62c4eec399cbdb37e118c8d90cf3e8501e397f578370f1974354e15e3fef61112b441001625835c3e2f8103d4f6848a9a3feece180d31
-  data.tar.gz: fb3966a8c2f435b7e99cd549fab55100e4434282be51c207492af7b2ff62eadd6897167b92043c0625228e2d88489caa392928a0c0ada16e7c9b6cb97e945c44
+  metadata.gz: eb153981a26cdf7530da2420db8092e2916b851b65edd01a25c2125dd8f70026a2650dd1137e24841378a6c030932347f80250c15511cee79513f1429000383b
+  data.tar.gz: 83f36e6351ae01cf77748bf9bbabf842b1383954836a968f52655c6bdeb1328d59fc748616f28a8ad9b25a150bd05735fc13914a94bc2902b80e36cbfd1d7bdd

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

@@ -0,0 +1,18 @@
+<div class="section">
+  <a name="list-of-endorsements"></a>
+  <div class="row">
+    <div class="columns large-12">
+      <h4 class="section-heading"><%= t("decidim.proposals.proposals.show.endorsements_list") %></h4>
+    </div>
+    <div class="columns large-12">
+      <%= cell(
+        "decidim/collapsible_list",
+        endorsers,
+        cell_name: "decidim/author",
+        cell_options: { extra_classes: ["author-data--small"] },
+        hidden_elements_count_i18n_key: "decidim.proposals.proposals.show.hidden_endorsers_count",
+        size: :small
+      ) %>
+    </div>
+  </div>
+</div>

data/app/cells/decidim/proposals/endorsers_list_cell.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Proposals
+    # This cell renders the list of endorsers for the given Proposal.
+    #
+    # Example:
+    #
+    #    cell("decidim/proposals/endorsers_list", my_proposal)
+    class EndorsersListCell < Decidim::ViewModel
+      include ProposalCellsHelper
+
+      def show
+        return unless endorsers.any?
+        render
+      end
+
+      private
+
+      # Finds the correct author for each endorsement.
+      #
+      # Returns an Array of presented Users/UserGroups
+      def endorsers
+        @endorsers ||= model.endorsements.for_listing.map { |identity| present(identity.normalized_author) }
+      end
+    end
+  end
+end

data/app/cells/decidim/proposals/proposal_cell.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Proposals
+    # This cell renders the proposal card for an instance of a Proposal
+    # the default size is the Medium Card (:m)
+    class ProposalCell < Decidim::ViewModel
+      include ProposalCellsHelper
+      include Cell::ViewModel::Partial
+      include Messaging::ConversationHelper
+
+      delegate :user_signed_in?, to: :parent_controller
+
+      def show
+        cell card_size, model, @options
+      end
+
+      private
+
+      def current_user
+        context[:current_user]
+      end
+
+      def card_size
+        "decidim/proposals/proposal_m"
+      end
+
+      def resource_path
+        resource_locator(model).path
+      end
+
+      def current_participatory_space
+        model.component.participatory_space
+      end
+
+      def component_name
+        translated_attribute current_component.name
+      end
+
+      def component_type_name
+        model.class.model_name.human
+      end
+
+      def participatory_space_name
+        translated_attribute current_participatory_space.title
+      end
+
+      def participatory_space_type_name
+        translated_attribute current_participatory_space.model_name.human
+      end
+    end
+  end
+end

data/app/cells/decidim/proposals/proposal_m/footer.erb

@@ -0,0 +1,23 @@
+<% if has_link_to_resource? %>
+  <div class="card__footer">
+    <div class="card__support">
+      <% if actionable? %>
+        <% if !current_settings.votes_hidden? %>
+          <%= cell(
+            "decidim/progress_bar",
+            progress_bar_progress,
+            total: progress_bar_total,
+            units_name: "decidim.proposals.proposals.votes_count.count",
+            element_id: "proposal-#{model.id}-votes-count",
+            subtitle_text: progress_bar_subtitle_text,
+            small: true
+          ) %>
+        <% end %>
+        <%= render partial: "decidim/proposals/proposals/vote_button.html", locals: { proposal: model, from_proposals_list: true } %>
+      <% else %>
+        <div class="card__support__data"></div>
+        <%= link_to t("decidim.proposals.proposals.proposal.view_proposal"), resource_path, class: "card__button button--sc light button small secondary" %>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/cells/decidim/proposals/proposal_m/tags.erb

@@ -0,0 +1 @@
+<%= render partial: "decidim/shared/tags.html", locals: { resource: model, tags_class_extra: "tags--proposal" } %>

data/app/cells/decidim/proposals/proposal_m_cell.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Proposals
+    # This cell renders a proposal with its M-size card.
+    class ProposalMCell < Decidim::CardMCell
+      include ProposalCellsHelper
+
+      def badge
+        render if has_badge?
+      end
+
+      private
+
+      def has_state?
+        model.published?
+      end
+
+      def has_badge?
+        answered? || withdrawn?
+      end
+
+      def has_link_to_resource?
+        model.published?
+      end
+
+      def description
+        truncate(model.body, length: 100)
+      end
+
+      def badge_classes
+        return super unless options[:full_badge]
+        state_classes.concat(["label", "proposal-status"]).join(" ")
+      end
+
+      def statuses
+        return [:creation_date, :endorsements_count, :comments_count] unless has_link_to_resource?
+        [:creation_date, :follow, :endorsements_count, :comments_count]
+      end
+
+      def endorsements_count_status
+        return endorsements_count unless has_link_to_resource?
+
+        link_to resource_path do
+          endorsements_count
+        end
+      end
+
+      def endorsements_count
+        with_tooltip t("decidim.proposals.models.proposal.fields.endorsements") do
+          icon("bullhorn", class: "icon--small") + " " + model.proposal_endorsements_count.to_s
+        end
+      end
+
+      def progress_bar_progress
+        model.proposal_votes_count || 0
+      end
+
+      def progress_bar_total
+        model.maximum_votes || 0
+      end
+
+      def progress_bar_subtitle_text
+        if progress_bar_progress >= progress_bar_total
+          t("decidim.proposals.proposals.votes_count.most_popular_proposal")
+        else
+          t("decidim.proposals.proposals.votes_count.need_more_votes")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+<figure>
+  <figcaption class="text-uppercase">
+    <strong>
+      <%= t("filed_as", scope: "decidim.proposals.proposals.tags") %>
+    </strong>
+  </figcaption>
+
+  <ul>
+    <% if category.present? %>
+      <li>
+        <%= link_to translated_attribute(category.name), resource_locator(model).index(filter: { category_id: category.id }) %>
+        <% if previous_category.present? && show_previous_category? %>
+          &nbsp;
+          <small class="text-small">
+            <%= t("changed_from", scope: "decidim.proposals.proposals.tags", previous_category: "#{previous_category.translated_name}").html_safe %>
+          </small>
+        <% end %>
+      </li>
+    <% end %>
+
+    <% if has_visible_scopes?(model) %>
+      <li><%= link_to translated_attribute(scope.name), resource_locator(model).index(filter: { scope_id: [scope.id] }) %></li>
+    <% end %>
+  </ul>
+</figure>

data/app/cells/decidim/proposals/proposal_tags_cell.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Proposals
+    # This cell renders the tags for a proposal.
+    class ProposalTagsCell < Decidim::ViewModel
+      include ProposalCellsHelper
+
+      property :category
+      property :previous_category
+      property :scope
+
+      def show
+        render if has_category_or_scopes?
+      end
+
+      private
+
+      def show_previous_category?
+        options[:show_previous_category].to_s != "false"
+      end
+
+      def has_category_or_scopes?
+        category.present? || has_visible_scopes?(model)
+      end
+    end
+  end
+end

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

@@ -8,12 +8,12 @@ module Decidim
         helper_method :proposal
 
         def edit
-          authorize! :update, proposal
+          enforce_permission_to :create, :proposal_answer
           @form = form(Admin::ProposalAnswerForm).from_model(proposal)
         end
 
         def update
-          authorize! :update, proposal
+          enforce_permission_to :create, :proposal_answer
           @form = form(Admin::ProposalAnswerForm).from_params(params)
 
           Admin::AnswerProposal.call(@form, proposal) do

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

@@ -8,12 +8,12 @@ module Decidim
         helper_method :proposal
 
         def index
-          authorize! :create, ProposalNote
+          enforce_permission_to :create, :proposal_note
           @form = form(ProposalNoteForm).instance
         end
 
         def create
-          authorize! :create, ProposalNote
+          enforce_permission_to :create, :proposal_note
           @form = form(ProposalNoteForm).from_params(params)
 
           CreateProposalNote.call(@form, proposal) do

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

@@ -9,14 +9,14 @@ module Decidim
         helper_method :proposals, :query
 
         def new
-          authorize! :create, Proposal
+          enforce_permission_to :create, :proposal
           @form = form(Admin::ProposalForm).from_params(
             attachment: form(AttachmentForm).from_params({})
           )
         end
 
         def create
-          authorize! :create, Proposal
+          enforce_permission_to :create, :proposal
           @form = form(Admin::ProposalForm).from_params(params)
 
           Admin::CreateProposal.call(@form) do
@@ -33,7 +33,7 @@ module Decidim
         end
 
         def update_category
-          authorize! :update, Proposal
+          enforce_permission_to :update, :proposal_category
           @proposal_ids = params[:proposal_ids]
 
           Admin::UpdateProposalCategory.call(params[:category][:id], params[:proposal_ids]) do

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

@@ -5,18 +5,16 @@ module Decidim
     module Admin
       class ProposalsImportsController < Admin::ApplicationController
         def new
-          authorize! :manage, current_component
+          enforce_permission_to :import, :proposals
 
           @form = form(Admin::ProposalsImportForm).instance
         end
 
         def create
-          authorize! :manage, current_component
+          enforce_permission_to :import, :proposals
 
           @form = form(Admin::ProposalsImportForm).from_params(params)
 
-          authorize! :manage, @form.origin_component
-
           Admin::ImportProposals.call(@form) do
             on(:ok) do |proposals|
               flash[:notice] = I18n.t("proposals_imports.create.success", scope: "decidim.proposals.admin", number: proposals.length)

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

@@ -9,11 +9,8 @@ module Decidim
     # override its layout and provide all kinds of useful methods.
     class ApplicationController < Decidim::Components::BaseController
       helper Decidim::Messaging::ConversationHelper
-
       helper_method :proposal_limit_reached?
 
-      private
-
       def proposal_limit
         return nil if component_settings.proposal_limit.zero?
         component_settings.proposal_limit

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

@@ -9,7 +9,7 @@ module Decidim
       before_action :authenticate_user!
 
       def create
-        authorize! :endorse, proposal
+        enforce_permission_to :endorse, :proposal, proposal: proposal
         @from_proposals_list = params[:from_proposals_list] == "true"
         user_group_id = params[:user_group_id]
 
@@ -26,7 +26,7 @@ module Decidim
       end
 
       def destroy
-        authorize! :unendorse, proposal
+        enforce_permission_to :unendorse, :proposal, proposal: proposal
         @from_proposals_list = params[:from_proposals_list] == "true"
         user_group_id = params[:user_group_id]
         user_group = current_user.user_groups.verified.find(user_group_id) if user_group_id
@@ -40,7 +40,7 @@ module Decidim
       end
 
       def identities
-        authorize! :endorse, proposal
+        enforce_permission_to :endorse, :proposal, proposal: proposal
 
         @user_verified_groups = current_user.user_groups.verified
         render :identities, layout: false

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

@@ -11,7 +11,7 @@ module Decidim
       before_action :authenticate_user!
 
       def create
-        authorize! :vote, proposal
+        enforce_permission_to :vote, :proposal, proposal: proposal
         @from_proposals_list = params[:from_proposals_list] == "true"
 
         VoteProposal.call(proposal, current_user) do
@@ -27,7 +27,7 @@ module Decidim
       end
 
       def destroy
-        authorize! :unvote, proposal
+        enforce_permission_to :unvote, :proposal, proposal: proposal
         @from_proposals_list = params[:from_proposals_list] == "true"
 
         UnvoteProposal.call(proposal, current_user) do

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

@@ -43,7 +43,7 @@ module Decidim
       end
 
       def new
-        authorize! :create, Proposal
+        enforce_permission_to :create, :proposal
         @step = :step_1
         if proposal_draft.present?
           redirect_to edit_draft_proposal_path(proposal_draft, component_id: proposal_draft.component.id, question_slug: proposal_draft.component.participatory_space.slug)
@@ -53,7 +53,7 @@ module Decidim
       end
 
       def create
-        authorize! :create, Proposal
+        enforce_permission_to :create, :proposal
         @step = :step_3
         @form = form(ProposalForm).from_params(params)
 
@@ -85,8 +85,9 @@ module Decidim
       end
 
       def complete
-        authorize! :create, Proposal
+        enforce_permission_to :create, :proposal
         @step = :step_3
+
         if params[:proposal].present?
           params[:proposal][:attachment] = form(AttachmentForm).from_params({})
           @form = form(ProposalForm).from_params(params)
@@ -118,14 +119,14 @@ module Decidim
 
       def edit_draft
         @step = :step_3
-        authorize! :edit, Proposal
+        enforce_permission_to :edit, :proposal, proposal: @proposal
 
         @form = form(ProposalForm).from_model(@proposal)
       end
 
       def update_draft
         @step = :step_1
-        authorize! :edit, @proposal
+        enforce_permission_to :edit, :proposal, proposal: @proposal
 
         @form = form(ProposalForm).from_params(params)
         UpdateProposal.call(@form, current_user, @proposal) do
@@ -142,7 +143,7 @@ module Decidim
       end
 
       def destroy_draft
-        authorize! :edit, Proposal
+        enforce_permission_to :edit, :proposal, proposal: @proposal
 
         DestroyProposal.call(@proposal, current_user) do
           on(:ok) do
@@ -159,14 +160,14 @@ module Decidim
 
       def edit
         @proposal = Proposal.published.not_hidden.where(component: current_component).find(params[:id])
-        authorize! :edit, @proposal
+        enforce_permission_to :edit, :proposal, proposal: @proposal
 
         @form = form(ProposalForm).from_model(@proposal)
       end
 
       def update
         @proposal = Proposal.not_hidden.where(component: current_component).find(params[:id])
-        authorize! :edit, @proposal
+        enforce_permission_to :edit, :proposal, proposal: @proposal
 
         @form = form(ProposalForm).from_params(params)
         UpdateProposal.call(@form, current_user, @proposal) do
@@ -184,7 +185,7 @@ module Decidim
 
       def withdraw
         @proposal = Proposal.published.not_hidden.where(component: current_component).find(params[:id])
-        authorize! :withdraw, @proposal
+        enforce_permission_to :withdraw, :proposal, proposal: @proposal
 
         WithdrawProposal.call(@proposal, current_user) do
           on(:ok) do |_proposal|
@@ -214,7 +215,7 @@ module Decidim
           origin: "all",
           activity: "",
           category_id: "",
-          state: "not_withdrawn",
+          state: "except_rejected",
           scope_id: nil,
           related_to: ""
         }

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

@@ -23,6 +23,8 @@ module Decidim
 
         validate :scope_belongs_to_participatory_space_scope
 
+        validate :notify_missing_attachment_if_errored
+
         delegate :categories, to: :current_component
 
         def map_model(model)
@@ -59,6 +61,14 @@ module Decidim
         def scope_belongs_to_participatory_space_scope
           errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
         end
+
+        # This method will add an error to the `attachment` field only if there's
+        # any error in any other field. This is needed because when the form has
+        # an error, the attachment is lost, so we need a way to inform the user of
+        # this problem.
+        def notify_missing_attachment_if_errored
+          errors.add(:attachment, :needs_to_be_reattached) if errors.any? && attachment.present?
+        end
       end
     end
   end

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

@@ -26,6 +26,8 @@ module Decidim
       validate :proposal_length
       validate :scope_belongs_to_participatory_space_scope
 
+      validate :notify_missing_attachment_if_errored
+
       delegate :categories, to: :current_component
 
       def map_model(model)
@@ -72,6 +74,14 @@ module Decidim
       def scope_belongs_to_participatory_space_scope
         errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
       end
+
+      # This method will add an error to the `attachment` field only if there's
+      # any error in any other field. This is needed because when the form has
+      # an error, the attachment is lost, so we need a way to inform the user of
+      # this problem.
+      def notify_missing_attachment_if_errored
+        errors.add(:attachment, :needs_to_be_reattached) if errors.any? && attachment.present?
+      end
     end
   end
 end

data/app/helpers/decidim/proposals/application_helper.rb

@@ -74,7 +74,7 @@ module Decidim
 
       def follow_button_for(model)
         if current_user
-          render partial: "decidim/shared/follow_button", locals: { followable: model }
+          render partial: "decidim/shared/follow_button.html", locals: { followable: model }
         else
           content_tag(:p, class: "mt-s mb-none") do
             t("decidim.proposals.proposals.show.sign_in_or_up",
@@ -83,29 +83,6 @@ module Decidim
           end
         end
       end
-
-      # Public - A widget that lists all identities in an xxs card format.
-      # Shows the first 5 identities and hides the rest, but presents a 'see all'
-      # button to make the rest of identities visible.
-      #
-      # @param identities: The list of identities. Each item must have a user_group or author method.
-      # @param widget_id: Mandatory when placing more than 1 widget in a page, optional otherwise. Is the id
-      #   uniquely identify this widget in the page.
-      #
-      def identities_list_xxs(identities, widget_id = "identities-xxs")
-        widget_ids = {
-          ellipsis: "#{widget_id}-ellipsis",
-          remaining_identities: "#{widget_id}-remaining-identities",
-          see_all_identities: "#{widget_id}-see-all-identities"
-        }
-        render partial: "identities_listing", locals: { identities: identities, widget_ids: widget_ids }
-      end
-
-      def identities_xxs(identities)
-        identities.collect do |identity|
-          render partial: "identity_xxs", locals: { identity: identity.normalized_author }
-        end.join(", ").html_safe
-      end
     end
   end
 end

data/app/helpers/decidim/proposals/proposal_cells_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # Custom helpers, scoped to the proposals engine.
+    #
+    module ProposalCellsHelper
+      include Decidim::Proposals::ApplicationHelper
+      include Decidim::Proposals::Engine.routes.url_helpers
+      include Decidim::LayoutHelper
+      include Decidim::ApplicationHelper
+      include Decidim::TranslationsHelper
+      include Decidim::ResourceReferenceHelper
+      include Decidim::TranslatableAttributes
+      include Decidim::CardHelper
+
+      delegate :title, :state, :answered?, :withdrawn?, to: :model
+
+      def actionable?
+        proposals_controller? && index_action? && current_settings.votes_enabled? && !model.draft?
+      end
+
+      def proposals_controller?
+        context[:controller].class.to_s == "Decidim::Proposals::ProposalsController"
+      end
+
+      def index_action?
+        context[:controller].action_name == "index"
+      end
+
+      def current_settings
+        model.component.current_settings
+      end
+
+      def component_settings
+        model.component.settings
+      end
+
+      def current_component
+        model.component
+      end
+
+      def from_context
+        @options[:from]
+      end
+
+      def badge_name
+        humanize_proposal_state state
+      end
+
+      def state_classes
+        case state
+        when "accepted"
+          ["success"]
+        when "rejected"
+          ["alert"]
+        when "evaluating"
+          ["warning"]
+        when "withdrawn"
+          ["alert"]
+        else
+          ["muted"]
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/proposals/proposal_votes_helper.rb

@@ -20,7 +20,7 @@ module Decidim
       #
       # Returns a string with the value of the css classes.
       def vote_button_classes(from_proposals_list)
-        return "small" if from_proposals_list
+        return "card__button button--sc" if from_proposals_list
         "expanded button--sc"
       end