decidim-proposals 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fedda0338cd11c26bf13d6aa263c43a07cd10436
-  data.tar.gz: be1a4f2582d285333a27462c8ef70869da7764e8
+SHA256:
+  metadata.gz: e91f7c5944cada8255ade51d10276d5c666db13515a2dba890ffa2415d4777bf
+  data.tar.gz: 94b46b9d2df7e575e7c5fb7c466a4388bb31d7d99a0242bcb5033ea17cf1796c
 SHA512:
-  metadata.gz: 5487d3f88af35b6f5e1df664322ca09b8b96cb1f020aff4e3fa8bdfc695d487e73775f5d2ad3e089c2ee5427337baa449abfcdfc3f0334e6e0afe4738c37c5a6
-  data.tar.gz: c7b66364e67f6101d673396cbf1eb2223c6beeda6433551eafcfbc1ccea017f4d3f56e318fb688218ca1e1a699d84898bae75d00eacb3fbc10efb61fd700ad64
+  metadata.gz: '0805a7c4f5b29dc9592ccbd5d818768ad3300dbd7666de2dbe4955a7aa6458031fa6e0efc969bb9f59a37ac15fbd44d790d6e0466bc72a4b574c30a468e25578'
+  data.tar.gz: 56d62ad991804d97365baa634e9ad8e7e7350d2f6fe910ec1459e0af8e8f5ccf75d56011da21f8dc439400a6a8b18c9b8d4a412cad1ed997ec400d3739e957a1

data/README.md

@@ -1,6 +1,6 @@
 # Decidim::Proposals
 
-The Proposals module adds one of the main features of Decidim: allows users to contribute to a particiaptory process by creating proposals.
+The Proposals module adds one of the main features of Decidim: allows users to contribute to a participatory process by creating proposals.
 
 ## Usage
 

data/app/assets/config/decidim_proposals_manifest.css

@@ -1 +1,3 @@
-/*= link decidim/proposals/social_share.css.scss */
+/*
+ *= link decidim/proposals/social_share.css.scss
+ */

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

@@ -16,8 +16,6 @@ $(() => {
       toggleInput();
       $checkbox.on('change', toggleInput);
     }
-
-    new window.Decidim.Select2Field($('#proposal_scope_id')); // eslint-disable-line no-new
   };
 
   window.DecidimProposals.bindProposalAddress();

data/app/assets/stylesheets/decidim/proposals/social_share.css.scss

@@ -1,19 +1,22 @@
-/*= require social-share-button */
+/*
+ *= require social-share-button
+ */
+
 $size: 45px;
 
-.share-link:hover {
+.share-link:hover{
   text-decoration: underline;
   cursor: pointer;
 }
 
-.social-share-button {
+.social-share-button{
   display: inline-block;
   vertical-align: top;
-  .ssb-icon {
+
+  .ssb-icon{
     margin-right: 5px;
     background-size: $size $size;
     height: $size;
     width: $size;
   }
 }
-

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

@@ -24,6 +24,8 @@ module Decidim
           return broadcast(:invalid) if form.invalid?
 
           answer_proposal
+          notify_followers
+
           broadcast(:ok)
         end
 
@@ -38,6 +40,36 @@ module Decidim
             answered_at: Time.current
           )
         end
+
+        def notify_followers
+          return if (proposal.previous_changes.keys & %w(state)).empty?
+
+          if proposal.accepted?
+            publish_event(
+              "decidim.events.proposals.proposal_accepted",
+              Decidim::Proposals::AcceptedProposalEvent
+            )
+          elsif proposal.rejected?
+            publish_event(
+              "decidim.events.proposals.proposal_rejected",
+              Decidim::Proposals::RejectedProposalEvent
+            )
+          elsif proposal.evaluating?
+            publish_event(
+              "decidim.events.proposals.proposal_evaluating",
+              Decidim::Proposals::EvaluatingProposalEvent
+            )
+          end
+        end
+
+        def publish_event(event, event_class)
+          Decidim::EventsManager.publish(
+            event: event,
+            event_class: event_class,
+            resource: proposal,
+            recipient_ids: proposal.followers.pluck(:id)
+          )
+        end
       end
     end
   end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      # A command with all the business logic when an admin creates a private note proposal.
+      class CreateProposalNote < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # current_user - The current user.
+        # proposal - the proposal to relate.
+        def initialize(form, proposal, current_user)
+          @form = form
+          @proposal = proposal
+          @current_user = current_user
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the note proposal.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_proposal_note
+
+          broadcast(:ok, proposal_note)
+        end
+
+        private
+
+        attr_reader :form, :proposal_note
+
+        def create_proposal_note
+          @proposal_note = ProposalNote.create!(
+            body: form.body,
+            proposal: @proposal,
+            author: @current_user
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -35,6 +35,7 @@ module Decidim
         transaction do
           create_proposal
           create_attachment if process_attachments?
+          send_notification
         end
 
         broadcast(:ok, proposal)
@@ -42,6 +43,17 @@ module Decidim
 
       private
 
+      def send_notification
+        return if proposal.author.blank?
+
+        Decidim::EventsManager.publish(
+          event: "decidim.events.proposals.proposal_created",
+          event_class: Decidim::Proposals::CreateProposalEvent,
+          resource: proposal,
+          recipient_ids: proposal.author.followers.pluck(:id)
+        )
+      end
+
       attr_reader :form, :proposal, :attachment
 
       def create_proposal

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # A command with all the business logic when a user withdraws a new proposal.
+    class WithdrawProposal < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # proposal     - The proposal to withdraw.
+      # current_user - The current user.
+      def initialize(proposal, current_user)
+        @proposal = proposal
+        @current_user = current_user
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid, together with the proposal.
+      # - :invalid if the proposal already has supports or does not belong to current user.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if @proposal.votes.any?
+
+        change_proposal_state_to_withdrawn
+
+        broadcast(:ok, @proposal)
+      end
+
+      private
+
+      def change_proposal_state_to_withdrawn
+        @proposal.update_attributes state: "withdrawn"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      # This controller allows admins to make private notes on proposals in a participatory process.
+      class ProposalNotesController < Admin::ApplicationController
+        helper_method :proposal
+
+        def index
+          authorize! :create, ProposalNote
+          @form = form(ProposalNoteForm).instance
+        end
+
+        def create
+          authorize! :create, ProposalNote
+          @form = form(ProposalNoteForm).from_params(params)
+
+          CreateProposalNote.call(@form, proposal, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("proposals.create.success", scope: "decidim")
+              redirect_to proposal_proposal_notes_path(proposal_id: proposal.id)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("proposals.create.error", scope: "decidim")
+              render :index
+            end
+          end
+        end
+
+        private
+
+        def proposal
+          @proposals ||= Proposal.where(feature: current_feature).find(params[:proposal_id])
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Decidim
       # This controller allows admins to manage proposals in a participatory process.
       class ProposalsController < Admin::ApplicationController
         helper Proposals::ApplicationHelper
-        helper_method :proposals
+        helper_method :proposals, :query
 
         def new
           authorize! :create, Proposal
@@ -34,8 +34,12 @@ module Decidim
 
         private
 
+        def query
+          @query ||= Proposal.where(feature: current_feature).ransack(params[:q])
+        end
+
         def proposals
-          @proposals ||= Proposal.where(feature: current_feature).page(params[:page]).per(15)
+          @proposals ||= query.result.page(params[:page]).per(15)
         end
 
         def proposal

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

@@ -55,7 +55,7 @@ module Decidim
         CreateProposal.call(@form, current_user) do
           on(:ok) do |proposal|
             flash[:notice] = I18n.t("proposals.create.success", scope: "decidim")
-            redirect_to proposal_path(proposal)
+            redirect_to Decidim::ResourceLocatorPresenter.new(proposal).path
           end
 
           on(:invalid) do
@@ -77,16 +77,31 @@ module Decidim
         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)
+            redirect_to Decidim::ResourceLocatorPresenter.new(proposal).path
           end
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("proposals.update.error", scope: "decidim")
-            render :new
+            render :edit
+          end
+        end
+      end
+
+      def withdraw
+        @proposal = Proposal.not_hidden.where(feature: current_feature).find(params[:id])
+        authorize! :withdraw, @proposal
+
+        WithdrawProposal.call(@proposal, current_user) do
+          on(:ok) do |_proposal|
+            flash[:notice] = I18n.t("proposals.update.success", scope: "decidim")
+            redirect_to Decidim::ResourceLocatorPresenter.new(@proposal).path
+          end
+          on(:invalid) do
+            flash[:alert] = I18n.t("proposals.update.error", scope: "decidim")
+            redirect_to Decidim::ResourceLocatorPresenter.new(@proposal).path
           end
         end
       end
@@ -107,7 +122,7 @@ module Decidim
           origin: "all",
           activity: "",
           category_id: "",
-          state: "all",
+          state: "not_withdrawn",
           scope_id: nil,
           related_to: ""
         }

data/app/events/decidim/proposals/accepted_proposal_event.rb

@@ -0,0 +1,9 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class AcceptedProposalEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+    end
+  end
+end

data/app/events/decidim/proposals/create_proposal_event.rb

@@ -0,0 +1,9 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class CreateProposalEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+    end
+  end
+end

data/app/events/decidim/proposals/evaluating_proposal_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class EvaluatingProposalEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/events/decidim/proposals/rejected_proposal_event.rb

@@ -0,0 +1,9 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class RejectedProposalEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+    end
+  end
+end

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

@@ -20,8 +20,9 @@ module Decidim
         validates :address, geocoding: true, if: -> { current_feature.settings.geocoding_enabled? }
         validates :category, presence: true, if: ->(form) { form.category_id.present? }
         validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+        validate { errors.add(:scope_id, :invalid) if current_participatory_space&.scope && !current_participatory_space&.scope&.ancestor_of?(scope) }
 
-        delegate :categories, to: :current_feature, prefix: false
+        delegate :categories, to: :current_feature
 
         def map_model(model)
           return unless model.categorization
@@ -29,28 +30,27 @@ module Decidim
           self.category_id = model.categorization.decidim_category_id
         end
 
-        def organization_scopes
-          current_organization.scopes
-        end
-
-        def process_scope
-          current_feature.participatory_space.scope
-        end
-
         alias feature current_feature
 
         # Finds the Category from the category_id.
         #
         # Returns a Decidim::Category
         def category
-          @category ||= categories.where(id: category_id).first
+          @category ||= categories.find_by(id: category_id)
         end
 
-        # Finds the Scope from the scope_id.
+        # Finds the Scope from the given decidim_scope_id, uses participatory space scope if missing.
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= organization_scopes.where(id: scope_id).first || process_scope
+          @scope ||= @scope_id ? current_feature.scopes.find_by(id: @scope_id) : current_participatory_space&.scope
+        end
+
+        # Scope identifier
+        #
+        # Returns the scope identifier related to the proposal
+        def scope_id
+          @scope_id || scope&.id
         end
       end
     end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      # A form object to be used when admin users want to create a proposal.
+      class ProposalNoteForm < Decidim::Form
+        mimic :proposal_note
+
+        attribute :body, String
+
+        validates :body, presence: true
+      end
+    end
+  end
+end