decidim-proposals 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: acab113b60556459cc59ae1328d6fbf71b7a84126a62787ebaca71deac6576d4
-  data.tar.gz: 1bc2d1b5aba3ddccef8ebce7290de7d6cf0cbba9b96d5f0e3e40d00993bba547
+SHA1:
+  metadata.gz: dd92afffe4d54576836db8fc75463fe8573cc096
+  data.tar.gz: 2e9aecf15cfed4d537d97181d5aa8e022c81daaf
 SHA512:
-  metadata.gz: 2320bdc81d1cb6eaf8166a915ba01b8870e1f7f1fdf5a500121a525e1d8feb3e3d1c3ae552c20d798142ada1f88a4f1dde3891b421925388bf30960feea523a3
-  data.tar.gz: 73abc903447deb8ccec3c3b3dcb98416dc2d79ab23a5c9fcd3cd68215cab18260f0d638ca4fbab82141d0ad304ccdce56b9a57c33d896576c5120f42cfd684a8
+  metadata.gz: 51c6c265feecc09e53c25fba2133b3c991a885483147a584b146412f68a206d90fb31b3545a061e36f20c6767875640099e78e7a26df62bfaf1690e0bbc43d78
+  data.tar.gz: 6dd296da8b15bace994407f59b4059a4e4019a6c9f75edf78411570d2d8a41230ed74db705302fc44a0edac7d7d9dce1dc451abff27406357886913abe099356

data/README.md

@@ -3,9 +3,11 @@
 The Proposals module adds one of the main features of Decidim: allows users to contribute to a particiaptory process by creating proposals.
 
 ## Usage
+
 Proposals will be available as a Feature for a Participatory Process.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -13,12 +15,15 @@ gem 'decidim-proposals
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle
 ```
 
 ## Contributing
+
 See [Decidim](https://github.com/decidim/decidim).
 
 ## License
+
 See [Decidim](https://github.com/decidim/decidim).

data/app/assets/javascripts/decidim/proposals/utils.js.es6

@@ -0,0 +1,11 @@
+/* eslint-disable no-invalid-this */
+
+(() => {
+  $("#vote_button").mouseover(function () {
+    $(this).text($(this).data('replace'));
+  });
+
+  $("#vote_button").mouseout(function () {
+    $(this).text($(this).data('original'));
+  });
+})(this);

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # A command with all the business logic when a user updates a proposal.
+    class UpdateProposal < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form         - A form object with the params.
+      # current_user - The current user.
+      # proposal - the proposal to update.
+      def initialize(form, current_user, proposal)
+        @form = form
+        @current_user = current_user
+        @proposal = proposal
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid, together with the proposal.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+        return broadcast(:invalid) unless proposal.editable_by?(current_user)
+        return broadcast(:invalid) if proposal_limit_reached?
+
+        if process_attachments?
+          build_attachment
+          return broadcast(:invalid) if attachment_invalid?
+        end
+
+        transaction do
+          update_proposal
+          create_attachment if process_attachments?
+        end
+
+        broadcast(:ok, proposal)
+      end
+
+      private
+
+      attr_reader :form, :proposal, :attachment, :current_user
+
+      def update_proposal
+        @proposal.update_attributes!(
+          title: form.title,
+          body: form.body,
+          category: form.category,
+          scope: form.scope,
+          author: current_user,
+          decidim_user_group_id: user_group.try(:id),
+          address: form.address,
+          latitude: form.latitude,
+          longitude: form.longitude
+        )
+      end
+
+      def build_attachment
+        @attachment = Attachment.new(
+          title: form.attachment.title,
+          file: form.attachment.file,
+          attached_to: proposal
+        )
+      end
+
+      def attachment_invalid?
+        if attachment.invalid? && attachment.errors.has_key?(:file)
+          form.attachment.errors.add :file, attachment.errors[:file]
+          true
+        end
+      end
+
+      def attachment_present?
+        form.attachment.file.present?
+      end
+
+      def create_attachment
+        attachment.attached_to = proposal
+        attachment.save!
+      end
+
+      def attachments_allowed?
+        form.current_feature.settings.attachments_allowed?
+      end
+
+      def process_attachments?
+        attachments_allowed? && attachment_present?
+      end
+
+      def proposal_limit_reached?
+        proposal_limit = form.current_feature.settings.proposal_limit
+
+        return false if proposal_limit.zero?
+
+        if user_group
+          user_group_proposals.count >= proposal_limit
+        else
+          current_user_proposals.count >= proposal_limit
+        end
+      end
+
+      def user_group
+        @user_group ||= Decidim::UserGroup.where(organization: organization, id: form.user_group_id).first
+      end
+
+      def organization
+        @organization ||= current_user.organization
+      end
+
+      def current_user_proposals
+        Proposal.where(author: current_user, feature: form.current_feature).where.not(id: proposal.id)
+      end
+
+      def user_group_proposals
+        Proposal.where(user_group: user_group, feature: form.current_feature).where.not(id: proposal.id)
+      end
+    end
+  end
+end

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

@@ -8,6 +8,8 @@ module Decidim
     # Note that it inherits from `Decidim::Features::BaseController`, which
     # override its layout and provide all kinds of useful methods.
     class ApplicationController < Decidim::Features::BaseController
+      helper Decidim::Messaging::ConversationHelper
+
       helper_method :proposal_limit_reached?
 
       private

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

@@ -65,6 +65,32 @@ module Decidim
         end
       end
 
+      def edit
+        @proposal = Proposal.not_hidden.where(feature: current_feature).find(params[:id])
+        authorize! :edit, @proposal
+
+        @form = form(ProposalForm).from_model(@proposal)
+      end
+
+      def update
+        @proposal = Proposal.not_hidden.where(feature: current_feature).find(params[:id])
+        authorize! :edit, @proposal
+
+        @form = form(ProposalForm).from_params(params)
+
+        UpdateProposal.call(@form, current_user, @proposal) do
+          on(:ok) do |proposal|
+            flash[:notice] = I18n.t("proposals.update.success", scope: "decidim")
+            redirect_to proposal_path(proposal)
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("proposals.update.error", scope: "decidim")
+            render :new
+          end
+        end
+      end
+
       private
 
       def geocoded_proposals

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

@@ -25,6 +25,9 @@ module Decidim
           end
 
           can :create, Proposal if authorized?(:create) && creation_enabled?
+          can :edit, Proposal do |proposal|
+            proposal.editable_by?(user)
+          end
 
           can :report, Proposal
         end

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

@@ -132,6 +132,29 @@ 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.
+      #
+      # user - the user to check for authorship
+      def authored_by?(user)
+        author == user || user.user_groups.include?(user_group)
+      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?
+      end
+
+      private
+
+      # Checks whether the proposal is inside the time window to be editable or not.
+      def within_edit_time_limit?
+        limit = created_at + feature.settings.proposal_edit_before_minutes.minutes
+        Time.current < limit
+      end
     end
   end
 end

data/app/views/decidim/proposals/admin/proposals/index.html.erb

@@ -70,7 +70,7 @@
               <% end %>
               <td class="table-list__actions">
                 <% if can? :update, proposal %>
-                  <%= icon_link_to "chat", edit_proposal_proposal_answer_path(proposal_id: proposal.id, id: proposal.id), t("actions.answer", scope: "decidim.proposals"), class: "action-icon--edit-answer" %>
+                  <%= icon_link_to "conversation", edit_proposal_proposal_answer_path(proposal_id: proposal.id, id: proposal.id), t("actions.answer", scope: "decidim.proposals"), class: "action-icon--edit-answer" %>
                 <% end %>
                 <%= icon_link_to "eye", resource_locator(proposal).path, t("actions.preview", scope: "decidim.proposals.admin"), class: "action-icon--preview", target: :blank %>
               </td>

data/app/views/decidim/proposals/proposals/_author.html.erb

@@ -18,6 +18,6 @@
         <%= t ".verified_user_group" %>
       </span>
     <% end %>
-    <%= l proposal.created_at, format: "%d/%m/%Y" %>
+    <%= l proposal.created_at, format: :decidim_short %>
   </div>
 </div>

data/app/views/decidim/proposals/proposals/_linked_proposals.html.erb

@@ -20,7 +20,9 @@
         </div>
       </div>
       <div class="card--list__data">
-        <%==t(".proposal_votes", count: proposal.votes.size) %>
+        <span class="card--list__data__number">
+          <%= proposal.votes.size %>
+        </span> <%= t(".proposal_votes", count: proposal.votes.size) %>
       </div>
     </div>
   <% end %>

data/app/views/decidim/proposals/proposals/_vote_button.html.erb

@@ -8,7 +8,7 @@
       <% end %>
     <% else %>
       <% if @voted_proposals ? @voted_proposals.include?(proposal.id) : proposal.voted_by?(current_user) %>
-        <%= action_authorized_button_to :vote, t('.already_voted'), proposal_proposal_vote_path(proposal_id: proposal, from_proposals_list: from_proposals_list), method: :delete, remote: true, data: { disable: true }, class: "card__button button #{vote_button_classes(from_proposals_list)} success" %>
+        <%= action_authorized_button_to :vote, t('.already_voted'), proposal_proposal_vote_path(proposal_id: proposal, from_proposals_list: from_proposals_list), method: :delete, remote: true, data: { disable: true, original: t('.already_voted'), replace: t('.already_voted_hover') }, class: "card__button button #{vote_button_classes(from_proposals_list)} success", id: "vote_button" %>
       <% else %>
         <% if proposal.maximum_votes_reached? %>
           <%= content_tag :span, t('.maximum_votes_reached'), class: "card__button button #{vote_button_classes(from_proposals_list)} disabled", disabled: true %>

data/app/views/decidim/proposals/proposals/edit.html.erb

@@ -0,0 +1,77 @@
+<div class="row columns">
+  <%= link_to :back, class: "muted-link" do %>
+    <%= icon "chevron-left", class: "icon--small" %>
+    <%= t(".back") %>
+  <% end %>
+  <h2 class="section-heading"><%= t(".title") %></h2>
+</div>
+
+<div class="row">
+  <div class="columns large-6 medium-centered">
+    <div class="card">
+      <% if translated_attribute(feature_settings.new_proposal_help_text).present? %>
+        <%= render partial: "decidim/shared/announcement", locals: { announcement: feature_settings.new_proposal_help_text } %>
+      <% end %>
+
+      <div class="card__content">
+        <%= decidim_form_for(@form) do |form| %>
+          <div class="field">
+            <%= form.text_field :title %>
+          </div>
+
+          <div class="field">
+            <%= form.text_area :body, rows: 10 %>
+          </div>
+
+          <% if feature_settings.geocoding_enabled? %>
+            <div class="field">
+              <%= form.check_box :has_address %>
+            </div>
+            <div class="field" id="address_input">
+              <%= form.text_field :address %>
+            </div>
+          <% end %>
+
+          <% if @form.categories&.any? %>
+            <div class="field">
+              <%= form.categories_select :category_id, @form.categories, prompt: t(".select_a_category") %>
+            </div>
+          <% end %>
+
+          <% if current_participatory_space.has_subscopes? %>
+            <div class="field">
+              <%= form.scopes_select :scope_id, prompt: I18n.t("decidim.scopes.global"), remote_path: decidim.scopes_search_path(root: current_participatory_space.scope) %>
+            </div>
+          <% end %>
+
+          <% if current_user.user_groups.verified.any? %>
+            <div class="field">
+              <%= form.select :user_group_id, current_user.user_groups.verified.map{|g| [g.name, g.id]}, prompt: current_user.name %>
+            </div>
+          <% end %>
+
+          <% if feature_settings.attachments_allowed? %>
+            <fieldset>
+              <legend><%= t('.attachment_legend') %></legend>
+              <%= form.fields_for :attachment, @form.attachment do |form| %>
+                <div class="field">
+                  <%= form.text_field :title %>
+                </div>
+
+                <div class="field">
+                  <%= form.upload :file, optional: false %>
+                </div>
+              <% end %>
+            </fieldset>
+          <% end %>
+
+          <div class="actions">
+            <%= form.submit t(".send"), class: "button expanded", "data-disable-with" => "#{t('.send')}..." %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= javascript_include_tag "decidim/proposals/add_proposal" %>

data/app/views/decidim/proposals/proposals/new.html.erb

@@ -13,6 +13,12 @@
         <%= render partial: "decidim/shared/announcement", locals: { announcement: feature_settings.new_proposal_help_text } %>
       <% end %>
 
+      <div class="row column">
+        <div class="callout warning">
+          <%= t(".proposal_edit_before_minutes", count: feature_settings.proposal_edit_before_minutes) %>
+        </div>
+      </div>
+
       <div class="card__content">
         <%= decidim_form_for(@form) do |form| %>
           <div class="field">

data/app/views/decidim/proposals/proposals/show.html.erb

@@ -13,11 +13,19 @@
       <button type="button" data-open="<%= current_user.present? ? 'flagModal' : 'loginModal' %>" title="<%= t('.report') %>" aria-controls="<%= current_user.present? ? 'flagModal' : 'loginModal' %>" aria-haspopup="true" tabindex="0">
         <%= icon "flag", aria_label: t('.report'), class: 'icon--small' %>
       </button>
+      <% unless @proposal.official? %>
+        <%= link_to link_to_current_or_new_conversation_with(@proposal.author), title: t('.contact') do %>
+          <%= icon "envelope-closed", aria_label: t('.contact'), class: 'icon--small' %>
+        <% end %>
+      <% end %>
     </div>
   </div>
 </div>
 <div class="row">
   <div class="columns section view-side mediumlarge-4 mediumlarge-push-8 large-3 large-push-9">
+    <% if can?(:edit, @proposal) %>
+      <%= link_to t(".edit_proposal"), edit_proposal_path(@proposal), class: "button secondary hollow expanded button-sc button--icon follow-button" %>
+    <% end %>
     <% if current_settings.votes_enabled? || current_user %>
       <div class="card extra">
         <div class="card__content">
@@ -49,21 +57,21 @@
         <div class="section">
           <div class="callout success">
             <h5><%= t(".proposal_accepted_reason") %></h5>
-            <p><%= sanitize translated_attribute @proposal.answer %></p>
+            <p><%= decidim_sanitize translated_attribute @proposal.answer %></p>
           </div>
         </div>
       <% elsif @proposal.rejected? %>
         <div class="section">
           <div class="callout warning">
             <h5><%= t(".proposal_rejected_reason") %></h5>
-            <p><%= sanitize translated_attribute @proposal.answer %></p>
+            <p><%= decidim_sanitize translated_attribute @proposal.answer %></p>
           </div>
         </div>
       <% else %>
         <div class="section">
           <div class="callout secondary">
             <h5><%= t(".proposal_in_evaluation_reason") %></h5>
-            <p><%= sanitize translated_attribute @proposal.answer %></p>
+            <p><%= decidim_sanitize translated_attribute @proposal.answer %></p>
           </div>
         </div>
       <% end %>

data/config/locales/ca.yml

@@ -23,12 +23,13 @@ ca:
             attachments_allowed: Permetre arxius adjunts
             comments_enabled: Comentaris habilitats
             geocoding_enabled: Geocodificació habilitada
-            maximum_votes_per_proposal: Vots màxims per proposta
+            maximum_votes_per_proposal: Suports màxims per proposta
             new_proposal_help_text: Text d'ajuda al crear una nova proposta
             official_proposals_enabled: Propostes oficials habilitades
             proposal_answering_enabled: Resposta oficial a propostes activades
+            proposal_edit_before_minutes: Les propostes poden ser editades pels autors abans que passin aquest nombre de minuts
             proposal_limit: Límit de propostes per usuari
-            vote_limit: Límit de vots per usuari
+            vote_limit: Límit de suports per usuari
           step:
             announcement: Avís
             comments_blocked: Comentaris bloquejats
@@ -36,7 +37,7 @@ ca:
             proposal_answering_enabled: Resposta oficial a propostes activades
             votes_blocked: Suports bloquejats
             votes_enabled: Suports habilitats
-            votes_hidden: Vots ocults (si els vots estan habilitats, marcant aquesta opció amagarà el nombre de vots)
+            votes_hidden: Suports ocults (si els suports estan habilitats, marcant aquesta opció amagarà el nombre de suports)
     proposals:
       actions:
         answer: Respondre
@@ -90,12 +91,12 @@ ca:
             scope: Àmbit
             state: Estat
             title: Títol
-            votes: Vots
+            votes: Suports
       new:
         limit_reached: No pots crear noves propostes ja que has superat el límit.
       proposal_votes:
         create:
-          error: Hi ha hagut errors en votar la proposta.
+          error: Hi ha hagut errors en donar suport a la proposta.
       proposals:
         author:
           deleted: Usuari eliminat
@@ -104,6 +105,12 @@ ca:
           proposals_count:
             one: 1 proposta
             other: "%{count} propostes"
+        edit:
+          attachment_legend: "(Opcional) Afegir un fitxer adjunt"
+          back: Enrere
+          select_a_category: Si us plau, selecciona una categoria
+          send: Enviar
+          title: Editar proposta
         filters:
           accepted: Acceptades
           activity: Activitat
@@ -120,7 +127,7 @@ ca:
           scopes: Àmbits
           search: Cerca
           state: Estat
-          voted: Votat
+          voted: Has donat suport
         filters_small_view:
           close_modal: Tancar finestra
           filter: Filtra
@@ -131,29 +138,35 @@ ca:
           view_proposal: Veure proposta
         linked_proposals:
           proposal_votes:
-            one: <span class="card--list__data__number">1</span>suport
-            other: <span class="card--list__data__number">%{count}</span>suports
+            one: suport
+            other: suports
         new:
           attachment_legend: "(Opcional) Afegiu un fitxer adjunt"
           back: Enrere
+          proposal_edit_before_minutes:
+            one: Podràs editar aquesta proposta durant el primer minut després de la creació de la proposta. Un cop passada aquesta finestra de temps, no podràs editar la proposta.
+            other: Podràs editar aquesta proposta durant els primers %{count} minuts després de la creació de la proposta. Un cop passada aquesta finestra de temps, no podràs editar la proposta.
           select_a_category: Si us plau, seleccioni una categoria
           send: Enviar
           title: Nova proposta
         orders:
           label: 'Ordenar propostes per:'
-          most_voted: Més votat
+          most_voted: Ha rebut més suports
           random: Aleatori
           recent: Recent
         proposal:
           view_proposal: Veure proposta
         show:
+          contact: Contactar
+          edit_proposal: Editar proposta
           proposal_accepted_reason: 'Aquesta proposta ha estat acceptada perquè:'
           proposal_in_evaluation_reason: S'està avaluant aquesta proposta
           proposal_rejected_reason: 'Aquesta proposta ha estat rebutjada perquè:'
           report: Informe
         vote_button:
-          already_voted: Ja has votat
-          maximum_votes_reached: S'ha arribat al límit de vots
+          already_voted: Ja li has donat suport
+          already_voted_hover: Retirar suport
+          maximum_votes_reached: S'ha arribat al límit de suports
           no_votes_remaining: No hi ha suports restants
           vote: Donar suport
           votes_blocked: Recollida de suports desactivada
@@ -163,14 +176,17 @@ ca:
             other: SUPORTS
         voting_rules:
           maximum_votes_per_proposal:
-            description: Cada proposta pot rebre un màxim de %{limit} vots.
+            description: Cada proposta pot rebre un màxim de %{limit} suports.
           proposal_limit:
             description: Pots crear fins a %{limit} propostes.
-          title: 'La votació es regeix per les següents normes:'
+          title: 'La selecció de propostes es regeix per les següents normes:'
           vote_limit:
-            description: Pots votar fins a %{limit} propostes.
+            description: Pots donar suport a %{limit} propostes.
             left: Restant
-            votes: Vots
+            votes: Suports
+      update:
+        error: Hi ha hagut errors en desar la proposta.
+        success: La proposta s'ha actualitzat correctament.
     resource_links:
       included_proposals:
         proposal_projects: 'Proposta formulada en aquests projectes:'

data/config/locales/en.yml

@@ -27,6 +27,7 @@ en:
             new_proposal_help_text: New proposal help text
             official_proposals_enabled: Official proposals enabled
             proposal_answering_enabled: Proposal answering enabled
+            proposal_edit_before_minutes: Proposals can be edited by authors before this many minutes passes
             proposal_limit: Proposal limit per user
             vote_limit: Vote limit per user
           step:
@@ -104,6 +105,12 @@ en:
           proposals_count:
             one: 1 proposal
             other: "%{count} proposals"
+        edit:
+          attachment_legend: "(Optional) Add an attachment"
+          back: Back
+          select_a_category: Please select a category
+          send: Send
+          title: Edit proposal
         filters:
           accepted: Accepted
           activity: Activity
@@ -131,11 +138,14 @@ en:
           view_proposal: View proposal
         linked_proposals:
           proposal_votes:
-            one: <span class="card--list__data__number">1</span>vote
-            other: <span class="card--list__data__number">%{count}</span>votes
+            one: vote
+            other: votes
         new:
           attachment_legend: "(Optional) Add an attachment"
           back: Back
+          proposal_edit_before_minutes:
+            one: You will be able to edit this proposal during the first minute after the proposal was created. Once this time window passes, you will not be able to edit the proposal.
+            other: You will be able to edit this proposal during the first %{count} minutes after the proposal was created. Once this time window passes, you will not be able to edit the proposal.
           select_a_category: Please select a category
           send: Send
           title: New proposal
@@ -147,12 +157,15 @@ en:
         proposal:
           view_proposal: View proposal
         show:
+          contact: Contact
+          edit_proposal: Edit proposal
           proposal_accepted_reason: 'This proposal has been accepted because:'
           proposal_in_evaluation_reason: This proposal is being evaluated
           proposal_rejected_reason: 'This proposal has been rejected because:'
           report: Report
         vote_button:
           already_voted: Already voted
+          already_voted_hover: Unvote
           maximum_votes_reached: Vote limit reached
           no_votes_remaining: No votes remaining
           vote: Vote
@@ -171,6 +184,9 @@ en:
             description: You can vote up to %{limit} proposals.
             left: Remaining
             votes: Votes
+      update:
+        error: There's been errors when saving the proposal.
+        success: Proposal updated successfully.
     resource_links:
       included_proposals:
         proposal_projects: 'Proposal appearing in these projects:'