decidim-proposals 0.9.3 → 0.10.0

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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    class CreationEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    class EndorsingEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class ProposalEndorsedEvent < Decidim::Events::SimpleEvent
+      i18n_attributes :endorser_nickname, :endorser_name, :endorser_path, :nickname
+
+      delegate :nickname, :name, to: :endorser, prefix: true
+
+      def nickname
+        endorser_nickname
+      end
+
+      def endorser_path
+        endorser.profile_path
+      end
+
+      private
+
+      def endorser
+        @endorser ||= Decidim::UserPresenter.new(endorser_user)
+      end
+
+      def endorser_user
+        @endorser_user ||= Decidim::User.find_by(id: extra[:endorser_id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Proposals
+    class PublishProposalEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+
+      private
+
+      def i18n_scope
+        return super unless participatory_space_event?
+
+        "decidim.events.proposals.proposal_published_for_space"
+      end
+
+      def participatory_space_event?
+        extra.dig(:participatory_space)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    class VotingEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

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

@@ -20,7 +20,8 @@ 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) }
+
+        validate :scope_belongs_to_participatory_space_scope
 
         delegate :categories, to: :current_feature
 
@@ -43,7 +44,7 @@ module Decidim
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= @scope_id ? current_feature.scopes.find_by(id: @scope_id) : current_participatory_space&.scope
+          @scope ||= @scope_id ? current_participatory_space.scopes.find_by(id: @scope_id) : current_participatory_space.scope
         end
 
         # Scope identifier
@@ -52,6 +53,12 @@ module Decidim
         def scope_id
           @scope_id || scope&.id
         end
+
+        private
+
+        def scope_belongs_to_participatory_space_scope
+          errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
+        end
       end
     end
   end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      # A form object to be used when admin users want to import a collection of proposals
+      # from another component.
+      class ProposalsImportForm < Decidim::Form
+        mimic :proposals_import
+
+        attribute :origin_feature_id, Integer
+        attribute :import_proposals, Boolean
+        attribute :states, Array
+
+        validates :origin_feature_id, :origin_feature, :states, :current_feature, presence: true
+        validates :import_proposals, allow_nil: false, acceptance: true
+        validate :valid_states
+
+        VALID_STATES = %w(accepted not_answered evaluating rejected withdrawn).freeze
+
+        def states_collection
+          VALID_STATES.map do |state|
+            OpenStruct.new(
+              name: I18n.t(state, scope: "decidim.proposals.answers"),
+              value: state
+            )
+          end
+        end
+
+        def states
+          super.reject(&:blank?)
+        end
+
+        def origin_feature
+          @origin_feature ||= origin_features.find_by(id: origin_feature_id)
+        end
+
+        def origin_features
+          @origin_features ||= current_participatory_space.features.where.not(id: current_feature.id).where(manifest_name: :proposals)
+        end
+
+        def origin_features_collection
+          origin_features.map do |feature|
+            [feature.name[I18n.locale.to_s], feature.id]
+          end
+        end
+
+        private
+
+        def valid_states
+          return if states.all? do |state|
+            VALID_STATES.include?(state)
+          end
+
+          errors.add(:states, :invalid)
+        end
+      end
+    end
+  end
+end

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

@@ -16,15 +16,15 @@ module Decidim
       attribute :user_group_id, Integer
       attribute :has_address, Boolean
       attribute :attachment, AttachmentForm
-
       validates :title, :body, presence: true, etiquette: true
       validates :title, length: { maximum: 150 }
-      validates :body, length: { maximum: 500 }, etiquette: true
       validates :address, geocoding: true, if: ->(form) { Decidim.geocoder.present? && form.has_address? }
       validates :address, presence: true, if: ->(form) { form.has_address? }
       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) }
+
+      validate :proposal_length
+      validate :scope_belongs_to_participatory_space_scope
 
       delegate :categories, to: :current_feature
 
@@ -35,7 +35,6 @@ module Decidim
       end
 
       alias feature current_feature
-
       # Finds the Category from the category_id.
       #
       # Returns a Decidim::Category
@@ -47,7 +46,7 @@ module Decidim
       #
       # Returns a Decidim::Scope
       def scope
-        @scope ||= @scope_id ? current_feature.scopes.find_by(id: @scope_id) : current_participatory_space&.scope
+        @scope ||= @scope_id ? current_participatory_space.scopes.find_by(id: @scope_id) : current_participatory_space.scope
       end
 
       # Scope identifier
@@ -60,6 +59,18 @@ module Decidim
       def has_address?
         current_feature.settings.geocoding_enabled? && has_address
       end
+
+      private
+
+      def proposal_length
+        return unless body.presence
+        length = current_feature.settings.proposal_length
+        errors.add(:body, :too_long, count: length) if body.length > length
+      end
+
+      def scope_belongs_to_participatory_space_scope
+        errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
+      end
     end
   end
 end

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

@@ -8,6 +8,7 @@ module Decidim
       include Decidim::Comments::CommentsHelper
       include PaginateHelper
       include ProposalVotesHelper
+      include ProposalEndorsementsHelper
       include Decidim::MapHelper
       include Decidim::Proposals::MapHelper
 

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # Simple helper to handle markup variations for proposal endorsements partials
+    module ProposalEndorsementsHelper
+      # Returns the css classes used for proposal endorsements count in both proposals list and show pages
+      #
+      # from_proposals_list - A boolean to indicate if the template is rendered from the proposals list page
+      #
+      # Returns a hash with the css classes for the count number and label
+      def endorsements_count_classes(from_proposals_list)
+        return { number: "card__support__number", label: "" } if from_proposals_list
+        { number: "extra__suport-number", label: "extra__suport-text" }
+      end
+
+      # Returns the css classes used for proposal endorsement button in both proposals list and show pages
+      #
+      # from_proposals_list - A boolean to indicate if the template is rendered from the proposals list page
+      #
+      # Returns a string with the value of the css classes.
+      def endorsement_button_classes(from_proposals_list)
+        return "small" if from_proposals_list
+        "small compact light button--sc expanded"
+      end
+
+      # Public: Checks if endorsement are enabled in this step.
+      #
+      # Returns true if enabled, false otherwise.
+      def endorsements_enabled?
+        current_settings.endorsements_enabled
+      end
+
+      # Public: Checks if endorsements are blocked in this step.
+      #
+      # Returns true if blocked, false otherwise.
+      def endorsements_blocked?
+        current_settings.endorsements_blocked
+      end
+
+      # Public: Checks if the current user is allowed to endorse in this step.
+      #
+      # Returns true if the current user can endorse, false otherwise.
+      def current_user_can_endorse?
+        current_user && endorsements_enabled? && !endorsements_blocked?
+      end
+
+      # Public: Checks if the card for endorsements should be rendered.
+      #
+      # Returns true if the endorsements card should be rendered, false otherwise.
+      def show_endorsements_card?
+        endorsements_enabled?
+      end
+
+      def endorsement_identity(endorsement)
+        endorsement.user_group ? endorsement.user_group : endorsement.author
+      end
+
+      # Public: Renders a button to endorse the given proposal.
+      # To override the translation for both buttons: endorse and unendorse (use to be the name of the user/user_group).
+      #
+      # @params (mandatory): proposal, from_proposals_list
+      # @params (optional) : user_group, btn_label
+      def endorsement_button(proposal, from_proposals_list, btn_label = nil, user_group = nil)
+        current_endorsement_url = proposal_proposal_endorsement_path(
+          proposal_id: proposal,
+          from_proposals_list: from_proposals_list,
+          user_group_id: user_group&.id
+        )
+        endorse_label = btn_label || t(".endorse")
+        unendorse_label = btn_label || t("decidim.proposals.proposal_endorsements_helper.endorsement_button.already_endorsed")
+
+        render partial: "decidim/proposals/proposals/endorsement_button", locals: { proposal: proposal,
+                                                                                    from_proposals_list: from_proposals_list, user_group: user_group,
+                                                                                    current_endorsement_url: current_endorsement_url,
+                                                                                    endorse_label: endorse_label, unendorse_label: unendorse_label }
+      end
+
+      #
+      # Public: Checks if the given Proposal has been endorsed by all identities of the user.
+      #
+      # @param proposal: The Proposal from which endorsements will be checked against.
+      # @param user:     The user whose identities and endorsements  will be checked against.
+      #
+      def fully_endorsed?(proposal, user)
+        return false unless user
+
+        user_group_endorsements = user.user_groups.verified.all? { |user_group| proposal.endorsed_by?(user, user_group) }
+
+        user_group_endorsements && proposal.endorsed_by?(user)
+      end
+
+      # Public: Renders an identity for endorsement.
+      #
+      # @params (mandatory): proposal, from_proposals_list
+      # @params (mandatory): user, the user that is endorsing at the end.
+      # @params (optional) : user_group, the user_group on behalf of which the endorsement is being done
+      def render_endorsement_identity(proposal, user, user_group = nil)
+        current_endorsement_url = proposal_proposal_endorsement_path(
+          proposal_id: proposal,
+          from_proposals_list: false,
+          user_group_id: user_group&.id,
+          authenticity_token: form_authenticity_token
+        )
+        presenter = if user_group
+                      Decidim::UserGroupPresenter.new(user_group)
+                    else
+                      Decidim::UserPresenter.new(user)
+                    end
+        selected = proposal.endorsed_by?(user, user_group)
+        http_method = selected ? :delete : :post
+        render partial: "decidim/proposals/proposal_endorsements/identity", locals:
+        { identity: presenter, selected: selected, current_endorsement_url: current_endorsement_url, http_method: http_method }
+      end
+    end
+  end
+end

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

@@ -39,19 +39,26 @@ module Decidim
         vote_limit.present?
       end
 
-      # Public: Checks if maximum votes per proposal are set.
+      # Public: Checks if threshold per proposal are set.
       #
       # Returns true if set, false otherwise.
-      def maximum_votes_per_proposal_enabled?
-        maximum_votes_per_proposal.present?
+      def threshold_per_proposal_enabled?
+        threshold_per_proposal.present?
       end
 
       # Public: Fetches the maximum amount of votes per proposal.
       #
       # Returns an Integer with the maximum amount of votes, nil otherwise.
-      def maximum_votes_per_proposal
-        return nil unless feature_settings.maximum_votes_per_proposal.positive?
-        feature_settings.maximum_votes_per_proposal
+      def threshold_per_proposal
+        return nil unless feature_settings.threshold_per_proposal.positive?
+        feature_settings.threshold_per_proposal
+      end
+
+      # Public: Checks if can accumulate more than maxium is enabled
+      #
+      # Returns true if enabled, false otherwise.
+      def can_accumulate_supports_beyond_threshold?
+        feature_settings.can_accumulate_supports_beyond_threshold
       end
 
       # Public: Checks if voting is enabled in this step.

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # Simple helpers to handle markup variations for proposal wizard partials
+    module ProposalWizardHelper
+      # Returns the css classes used for the proposal wizard for the desired step
+      #
+      # step - A symbol of the target step
+      # current_step - A symbol of the current step
+      #
+      # Returns a string with the css classes for the desired step
+      def proposal_wizard_step_classes(step, current_step)
+        step_i = step.to_s.split("_").last.to_i
+        if step_i == proposal_wizard_step_number(current_step)
+          %(step--active #{step} #{current_step})
+        elsif step_i < proposal_wizard_step_number(current_step)
+          %(step--past #{step})
+        else
+          %()
+        end
+      end
+
+      # Returns the number of the step
+      #
+      # step - A symbol of the target step
+      def proposal_wizard_step_number(step)
+        step.to_s.split("_").last.to_i
+      end
+
+      # Returns the name of the step, translated
+      #
+      # step - A symbol of the target step
+      def proposal_wizard_step_name(step)
+        t(:"decidim.proposals.proposals.wizard_steps.#{step}")
+      end
+
+      # Returns the page title of the given step, translated
+      #
+      # action_name - A string of the rendered action
+      def proposal_wizard_step_title(action_name)
+        step_title = case action_name
+                     when "create"
+                       "new"
+                     when "update_draft"
+                       "edit_draft"
+                     else
+                       action_name
+                     end
+
+        t("decidim.proposals.proposals.#{step_title}.title")
+      end
+
+      # Returns the list item of the given step, in html
+      #
+      # step - A symbol of the target step
+      # current_step - A symbol of the current step
+      def proposal_wizard_stepper_step(step, current_step)
+        content_tag(:li, proposal_wizard_step_name(step), class: proposal_wizard_step_classes(step, current_step).to_s)
+      end
+
+      # Returns the list with all the steps, in html
+      #
+      # current_step - A symbol of the current step
+      def proposal_wizard_stepper(current_step)
+        content_tag :ol, class: "wizard__steps" do
+          %(
+            #{proposal_wizard_stepper_step(:step_1, current_step)}
+            #{proposal_wizard_stepper_step(:step_2, current_step)}
+            #{proposal_wizard_stepper_step(:step_3, current_step)}
+          ).html_safe
+        end
+      end
+
+      # Returns a string with the current step number and the total steps number
+      #
+      # step - A symbol of the target step
+      def proposal_wizard_current_step_of(step)
+        current_step_num = proposal_wizard_step_number(step)
+        content_tag :span, class: "text-small" do
+          concat t(:"decidim.proposals.proposals.wizard_steps.step_of", current_step_num: current_step_num, total_steps: 3)
+          concat " ("
+          concat content_tag :a, t(:"decidim.proposals.proposals.wizard_steps.see_steps"), "data-toggle": "steps"
+          concat ")"
+        end
+      end
+
+      # Returns a boolean if the step has a help text defined
+      #
+      # step - A symbol of the target step
+      def proposal_wizard_step_help_text?(step)
+        translated_attribute(feature_settings.try("proposal_wizard_#{step}_help_text")).present?
+      end
+
+      # Renders a user_group select field in a form.
+      # form - FormBuilder object
+      # name - attribute user_group_id
+      #
+      # Returns nothing.
+      def user_group_select_field(form, name)
+        form.select(name, current_user.user_groups.verified.map { |g| [g.name, g.id] }, prompt: current_user.name)
+      end
+    end
+  end
+end