decidim-proposals 0.28.1 → 0.29.0.rc1

data/db/migrate/20240209092404_change_color_fields_on_proposals_states.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class ChangeColorFieldsOnProposalsStates < ActiveRecord::Migration[6.1]
+  class ProposalState < ApplicationRecord
+    self.table_name = :decidim_proposals_proposal_states
+
+    def self.colors
+      {
+        gray: {
+          background: "#F6F8FA",
+          foreground: "#4B5058"
+        },
+        green: {
+          background: "#E3FCE9",
+          foreground: "#15602C"
+        },
+        orange: {
+          background: "#FFF1E5",
+          foreground: "#BC4C00"
+        },
+        red: {
+          background: "#FFEBE9",
+          foreground: "#D1242F"
+        }
+      }
+    end
+  end
+
+  def up
+    colors = ProposalState.colors
+
+    add_column :decidim_proposals_proposal_states, :bg_color, :string, default: colors[:gray][:background], null: false
+    add_column :decidim_proposals_proposal_states, :text_color, :string, default: colors[:gray][:foreground], null: false
+    remove_column :decidim_proposals_proposal_states, :css_class
+
+    # rubocop:disable Rails/SkipsModelValidations
+    ProposalState.where(token: :accepted).update_all(
+      bg_color: colors[:green][:background], text_color: colors[:green][:foreground]
+    )
+    ProposalState.where(token: :evaluating).update_all(
+      bg_color: colors[:orange][:background], text_color: colors[:orange][:foreground]
+    )
+    ProposalState.where(token: :rejected).update_all(
+      bg_color: colors[:red][:background], text_color: colors[:red][:foreground]
+    )
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+
+  def down
+    remove_column :decidim_proposals_proposal_states, :bg_color
+    remove_column :decidim_proposals_proposal_states, :text_color
+    add_column :decidim_proposals_proposal_states, :css_class, :string
+  end
+end

data/decidim-proposals.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
     "homepage_uri" => "https://decidim.org",
     "source_code_uri" => "https://github.com/decidim/decidim"
   }
-  s.required_ruby_version = "~> 3.1.0"
+  s.required_ruby_version = "~> 3.2.0"
 
   s.name = "decidim-proposals"
   s.summary = "Decidim proposals module"
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "decidim-comments", Decidim::Proposals.version
   s.add_dependency "decidim-core", Decidim::Proposals.version
-  s.add_dependency "doc2text", "~> 0.4.6"
+  s.add_dependency "doc2text", "~> 0.4.7"
   s.add_dependency "redcarpet", "~> 3.5", ">= 3.5.1"
 
   s.add_development_dependency "decidim-admin", Decidim::Proposals.version

data/lib/decidim/api/proposal_type.rb

@@ -26,6 +26,7 @@ module Decidim
       def coordinates
         [object.latitude, object.longitude]
       end
+
       field :reference, GraphQL::Types::String, "This proposal's unique reference", null: true
       field :state, GraphQL::Types::String, "The answer status in which proposal is in", null: true
       field :answer, Decidim::Core::TranslatedFieldType, "The answer feedback for the status for this proposal", null: true
@@ -41,6 +42,9 @@ module Decidim
       field :created_in_meeting, GraphQL::Types::Boolean, "Whether this proposal comes from a meeting or not", method: :official_meeting?, null: true
       field :meeting, Decidim::Meetings::MeetingType, description: "If the proposal comes from a meeting, the related meeting", null: true
 
+      field :withdrawn_at, Decidim::Core::DateTimeType, description: "The date and time this proposal was withdrawn", null: true
+      field :withdrawn, GraphQL::Types::Boolean, "Whether this proposal has been withdrawn or not", method: :withdrawn?, null: true
+
       def meeting
         object.authors.first if object.official_meeting?
       end

data/lib/decidim/proposals/admin_engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "decidim/proposals/admin_filter"
+
 module Decidim
   module Proposals
     # This is the engine that runs on the public interface of `decidim-proposals`.
@@ -25,6 +27,8 @@ module Decidim
           resources :proposal_notes, only: [:create]
         end
 
+        resources :proposal_states
+
         resources :participatory_texts, only: [:index] do
           collection do
             get :new_import
@@ -38,6 +42,10 @@ module Decidim
         root to: "proposals#index"
       end
 
+      initializer "decidim_proposals.admin_filters" do
+        Decidim::Proposals::AdminFilter.register_filter!
+      end
+
       def load_seed
         nil
       end

data/lib/decidim/proposals/admin_filter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    class AdminFilter
+      def self.register_filter!
+        Decidim.admin_filter(:proposals) do |configuration|
+          configuration.add_filters(
+            :is_emendation_true,
+            :state_eq,
+            :with_any_state,
+            :scope_id_eq,
+            :category_id_eq,
+            :valuator_role_ids_has
+          )
+
+          configuration.add_filters_with_values(
+            is_emendation_true: %w(true false),
+            state_eq: state_eq_values,
+            with_any_state: %w(state_published state_not_published),
+            scope_id_eq: scope_ids_hash(scopes.top_level),
+            category_id_eq: category_ids_hash(categories.first_class),
+            valuator_role_ids_has: valuator_role_ids
+          )
+
+          configuration.add_dynamically_translated_filters(
+            :scope_id_eq,
+            :category_id_eq,
+            :valuator_role_ids_has,
+            :proposal_state_id_eq,
+            :state_eq
+          )
+        end
+      end
+    end
+  end
+end

data/lib/decidim/proposals/component.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "decidim/meetings"
-
 Decidim.register_component(:proposals) do |component|
   component.engine = Decidim::Proposals::Engine
   component.admin_engine = Decidim::Proposals::AdminEngine
@@ -13,6 +11,11 @@ Decidim.register_component(:proposals) do |component|
     raise "Cannot destroy this component when there are proposals" if Decidim::Proposals::Proposal.where(component: instance).any?
   end
 
+  component.on(:create) do |instance|
+    admin_user = GlobalID::Locator.locate(instance.versions.first.whodunnit)
+    Decidim::Proposals.create_default_states!(instance, admin_user)
+  end
+
   component.data_portable_entities = ["Decidim::Proposals::Proposal"]
 
   component.newsletter_participant_entities = ["Decidim::Proposals::Proposal"]
@@ -23,7 +26,7 @@ Decidim.register_component(:proposals) do |component|
 
   component.permissions_class_name = "Decidim::Proposals::Permissions"
 
-  POSSIBLE_SORT_ORDERS = %w(default random recent most_endorsed most_voted most_commented most_followed with_more_authors).freeze
+  POSSIBLE_SORT_ORDERS = %w(automatic random recent most_endorsed most_voted most_commented most_followed with_more_authors).freeze
 
   component.settings(:global) do |settings|
     settings.attribute :scopes_enabled, type: :boolean, default: false
@@ -35,9 +38,9 @@ Decidim.register_component(:proposals) do |component|
     settings.attribute :proposal_edit_time, type: :enum, default: "limited", choices: -> { %w(limited infinite) }
     settings.attribute :proposal_edit_before_minutes, type: :integer, default: 5, required: true
     settings.attribute :threshold_per_proposal, type: :integer, default: 0, required: true
-    settings.attribute :can_accumulate_supports_beyond_threshold, type: :boolean, default: false
+    settings.attribute :can_accumulate_votes_beyond_threshold, type: :boolean, default: false
     settings.attribute :proposal_answering_enabled, type: :boolean, default: true
-    settings.attribute :default_sort_order, type: :select, default: "default", choices: -> { POSSIBLE_SORT_ORDERS }
+    settings.attribute :default_sort_order, type: :select, default: "automatic", choices: -> { POSSIBLE_SORT_ORDERS }
     settings.attribute :official_proposals_enabled, type: :boolean, default: true
     settings.attribute :comments_enabled, type: :boolean, default: true
     settings.attribute :comments_max_length, type: :integer, required: true
@@ -58,8 +61,6 @@ Decidim.register_component(:proposals) do |component|
     settings.attribute :new_proposal_help_text, type: :text, translated: true, editor: true
     settings.attribute :proposal_wizard_step_1_help_text, type: :text, translated: true, editor: true
     settings.attribute :proposal_wizard_step_2_help_text, type: :text, translated: true, editor: true
-    settings.attribute :proposal_wizard_step_3_help_text, type: :text, translated: true, editor: true
-    settings.attribute :proposal_wizard_step_4_help_text, type: :text, translated: true, editor: true
   end
 
   component.settings(:step) do |settings|
@@ -101,14 +102,14 @@ Decidim.register_component(:proposals) do |component|
   end
 
   component.register_stat :proposals_count, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
-    Decidim::Proposals::FilteredProposals.for(components, start_at, end_at).published.except_withdrawn.not_hidden.count
+    Decidim::Proposals::FilteredProposals.for(components, start_at, end_at).published.not_withdrawn.not_hidden.count
   end
 
   component.register_stat :proposals_accepted, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
     Decidim::Proposals::FilteredProposals.for(components, start_at, end_at).accepted.not_hidden.count
   end
 
-  component.register_stat :supports_count, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
+  component.register_stat :votes_count, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
     proposals = Decidim::Proposals::FilteredProposals.for(components, start_at, end_at).published.not_hidden
     Decidim::Proposals::ProposalVote.where(proposal: proposals).count
   end

data/lib/decidim/proposals/engine.rb

@@ -13,8 +13,6 @@ module Decidim
       routes do
         resources :proposals, except: [:destroy] do
           member do
-            get :compare
-            get :complete
             get :edit_draft
             patch :update_draft
             get :preview
@@ -57,6 +55,7 @@ module Decidim
         Decidim.icons.register(name: "arrow-right-s-fill", icon: "arrow-right-s-fill", category: "system", description: "", engine: :proposals)
         Decidim.icons.register(name: "bar-chart-2-line", icon: "bar-chart-2-line", category: "system", description: "", engine: :proposals)
         Decidim.icons.register(name: "scales-line", icon: "scales-line", category: "system", description: "", engine: :proposals)
+        Decidim.icons.register(name: "layout-grid-fill", icon: "layout-grid-fill", category: "system", description: "", engine: :proposals)
       end
 
       initializer "decidim_proposals.content_processors" do |_app|
@@ -92,19 +91,6 @@ module Decidim
         end
       end
 
-      # Subscribes to ActiveSupport::Notifications that may affect a Proposal.
-      initializer "decidim_proposals.subscribe_to_events" do
-        # when a proposal is linked from a result
-        event_name = "decidim.resourceable.included_proposals.created"
-        ActiveSupport::Notifications.subscribe event_name do |_name, _started, _finished, _unique_id, data|
-          payload = data[:this]
-          if payload[:from_type] == Decidim::Accountability::Result.name && payload[:to_type] == Proposal.name
-            proposal = Proposal.find(payload[:to_id])
-            proposal.update(state: "accepted", state_published_at: Time.current)
-          end
-        end
-      end
-
       initializer "decidim_proposals.add_cells_view_paths" do
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Proposals::Engine.root}/app/cells")
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Proposals::Engine.root}/app/views") # for proposal partials

data/lib/decidim/proposals/import/proposal_answer_creator.rb

@@ -6,9 +6,7 @@ module Decidim
       # This class is responsible for creating the imported proposal answers
       # and must be included in proposals component's import manifest.
       class ProposalAnswerCreator < Decidim::Admin::Import::Creator
-        POSSIBLE_ANSWER_STATES = %w(evaluating accepted rejected).freeze
-
-        # Retuns the resource class to be created with the provided data.
+        # Returns the resource class to be created with the provided data.
         def self.resource_klass
           Decidim::Proposals::Proposal
         end
@@ -58,10 +56,12 @@ module Decidim
 
           proposal.answer = answer
           proposal.answered_at = Time.current
-          @initial_state = proposal.state
+          @initial_state = proposal.proposal_state
+
+          proposal_state = Decidim::Proposals::ProposalState.where(component:, token: state).first
 
-          if POSSIBLE_ANSWER_STATES.include?(state)
-            proposal.state = state
+          if proposal_state.present?
+            proposal.proposal_state = proposal_state
             proposal.state_published_at = Time.current if component.current_settings.publish_answers_immediately?
           else
             proposal.errors.add(:state, :invalid)

data/lib/decidim/proposals/import/proposal_creator.rb

@@ -6,7 +6,7 @@ module Decidim
       # This class is responsible for creating the imported proposals
       # and must be included in proposals component's import manifest.
       class ProposalCreator < Decidim::Admin::Import::Creator
-        # Retuns the resource class to be created with the provided data.
+        # Returns the resource class to be created with the provided data.
         def self.resource_klass
           Decidim::Proposals::Proposal
         end

data/lib/decidim/proposals/markdown_to_proposals.rb

@@ -41,14 +41,8 @@ module Decidim
 
       # Block-level calls ######################
 
-      # Recarpet callback to preprocess the document.
-      # Removes the HTML comment from the markdown file
-      def preprocess(document)
-        document.gsub(/<!--.*-->/, "")
-      end
-
       # Recarpet callback to process headers.
-      # Creates Paricipatory Text Proposals at Section and Subsection levels.
+      # Creates Participatory Text Proposals at Section and Subsection levels.
       def header(title, level)
         participatory_text_level = if level > 1
                                      Decidim::Proposals::ParticipatoryTextSection::LEVELS[:sub_section]
@@ -63,7 +57,7 @@ module Decidim
       end
 
       # Recarpet callback to process paragraphs.
-      # Creates Paricipatory Text Proposals at Article level.
+      # Creates Participatory Text Proposals at Article level.
       def paragraph(text)
         return if text.blank?
 

data/lib/decidim/proposals/proposal_serializer.rb

@@ -19,6 +19,9 @@ module Decidim
       def serialize
         {
           id: proposal.id,
+          author: {
+            **author_fields
+          },
           category: {
             id: proposal.category.try(:id),
             name: proposal.category.try(:name) || empty_translatable
@@ -41,13 +44,13 @@ module Decidim
           reference: proposal.reference,
           answer: ensure_translatable(proposal.answer),
           answered_at: proposal.answered_at,
-          supports: proposal.proposal_votes_count,
+          votes: proposal.proposal_votes_count,
           endorsements: {
             total_count: proposal.endorsements.size,
             user_endorsements:
           },
           comments: proposal.comments_count,
-          attachments: proposal.attachments.count,
+          attachments: proposal.attachments.size,
           followers: proposal.follows.size,
           published_at: proposal.published_at,
           url:,
@@ -57,7 +60,9 @@ module Decidim
           original_proposal: {
             title: proposal&.amendable&.title,
             url: original_proposal_url
-          }
+          },
+          withdrawn: proposal.withdrawn?,
+          withdrawn_at: proposal.withdrawn_at
         }
       end
 
@@ -102,6 +107,54 @@ module Decidim
 
         convert_to_text(value)
       end
+
+      def author_fields
+        is_author_user_group = resource.coauthorships.map(&:decidim_user_group_id).any?
+
+        {
+          id: resource.authors.map(&:id),
+          name: resource.authors.map do |author|
+            author_name(is_author_user_group ? resource.coauthorships.first.user_group : author)
+          end,
+          url: resource.authors.map do |author|
+            author_url(is_author_user_group ? resource.coauthorships.first.user_group : author)
+          end
+        }
+      end
+
+      def author_name(author)
+        if author.respond_to?(:name)
+          translated_attribute(author.name) # is a Decidim::User or Decidim::Organization or Decidim::UserGroup
+        elsif author.respond_to?(:title)
+          translated_attribute(author.title) # is a Decidim::Meetings::Meeting
+        end
+      end
+
+      def author_url(author)
+        if author.respond_to?(:nickname)
+          profile_url(author.nickname) # is a Decidim::User or Decidim::UserGroup
+        elsif author.respond_to?(:title)
+          meeting_url(author) # is a Decidim::Meetings::Meeting
+        else
+          root_url # is a Decidim::Organization
+        end
+      end
+
+      def profile_url(nickname)
+        Decidim::Core::Engine.routes.url_helpers.profile_url(nickname, host:)
+      end
+
+      def meeting_url(meeting)
+        Decidim::EngineRouter.main_proxy(meeting.component).meeting_url(id: meeting.id, host:)
+      end
+
+      def root_url
+        Decidim::Core::Engine.routes.url_helpers.root_url(host:)
+      end
+
+      def host
+        resource.organization.host
+      end
     end
   end
 end

data/lib/decidim/proposals/seeds.rb

@@ -15,6 +15,8 @@ module Decidim
       def call
         component = create_component!
 
+        Decidim::Proposals.create_default_states!(component, admin_user)
+
         5.times do |n|
           proposal = create_proposal!(component:)
 
@@ -34,6 +36,9 @@ module Decidim
         end
 
         update_traceability!(component:)
+
+        create_report!(reportable: Decidim::Proposals::Proposal.take, current_user: Decidim::User.take)
+        hide_report!(reportable: Decidim::Proposals::Proposal.take)
       end
 
       def organization
@@ -54,6 +59,7 @@ module Decidim
           participatory_space:,
           settings: {
             vote_limit: 0,
+            attachments_allowed: [true, false].sample,
             collaborative_drafts_enabled: true
           },
           step_settings:
@@ -70,18 +76,8 @@ module Decidim
       end
 
       def create_proposal!(component:)
-        n = rand(5)
-        state, answer, state_published_at = if n > 3
-                                              ["accepted", Decidim::Faker::Localized.sentence(word_count: 10), Time.current]
-                                            elsif n > 2
-                                              ["rejected", nil, Time.current]
-                                            elsif n > 1
-                                              ["evaluating", nil, Time.current]
-                                            elsif n.positive?
-                                              ["accepted", Decidim::Faker::Localized.sentence(word_count: 10), nil]
-                                            else
-                                              ["not_answered", nil, nil]
-                                            end
+        proposal_state, answer, state_published_at = random_state_answer
+        proposal_state = Decidim::Proposals::ProposalState.where(component:, token: proposal_state).first
 
         params = {
           component:,
@@ -89,9 +85,9 @@ module Decidim
           scope: random_scope(participatory_space:),
           title: { en: ::Faker::Lorem.sentence(word_count: 2) },
           body: { en: ::Faker::Lorem.paragraphs(number: 2).join("\n") },
-          state:,
+          proposal_state:,
           answer:,
-          answered_at: state.present? ? Time.current : nil,
+          answered_at: proposal_state.present? ? Time.current : nil,
           state_published_at:,
           published_at: Time.current
         }
@@ -103,22 +99,57 @@ module Decidim
           visibility: "all"
         ) do
           proposal = Decidim::Proposals::Proposal.new(params)
-          meeting_component = participatory_space.components.find_by(manifest_name: "meetings")
-
-          coauthor = case n
-                     when 0
-                       Decidim::User.where(organization:).sample
-                     when 1
-                       Decidim::UserGroup.where(organization:).sample
-                     when 2
-                       Decidim::Meetings::Meeting.where(component: meeting_component).sample
-                     else
-                       organization
-                     end
+          coauthor = random_coauthor
           proposal.add_coauthor(coauthor)
           proposal.save!
+
+          Decidim::EventsManager.publish(
+            event: "decidim.events.proposals.proposal_published_for_space",
+            event_class: Decidim::Proposals::PublishProposalEvent,
+            resource: proposal,
+            followers: proposal.participatory_space.followers
+          )
+
           proposal
         end
+
+        create_attachment(attached_to: proposal, filename: "city.jpeg") if component.settings.attachments_allowed?
+
+        proposal
+      end
+
+      def random_state_answer
+        n = rand(5)
+
+        if n > 3
+          [:accepted, Decidim::Faker::Localized.sentence(word_count: 10), Time.current]
+        elsif n > 2
+          [:rejected, nil, Time.current]
+        elsif n > 1
+          [:evaluating, nil, Time.current]
+        elsif n.positive?
+          [:accepted, Decidim::Faker::Localized.sentence(word_count: 10), nil]
+        else
+          [:not_answered, nil, nil]
+        end
+      end
+
+      def random_coauthor
+        n = rand(5)
+        n = 3 if n == 2 && !Decidim.module_installed?(:meetings)
+
+        case n
+        when 0
+          Decidim::User.where(organization:).sample
+        when 1
+          Decidim::UserGroup.where(organization:).sample
+        when 2
+          meeting_component = participatory_space.components.find_by(manifest_name: "meetings")
+
+          Decidim::Meetings::Meeting.where(component: meeting_component).sample
+        else
+          organization
+        end
       end
 
       def random_nickname
@@ -132,15 +163,7 @@ module Decidim
       end
 
       def create_emendation!(proposal:)
-        author = Decidim::User.find_or_initialize_by(email: random_email(suffix: "amendment"))
-        author.update!(
-          password: "decidim123456789",
-          name: "#{::Faker::Name.name} #{participatory_space.id}",
-          nickname: random_nickname,
-          organization:,
-          tos_agreement: "1",
-          confirmed_at: Time.current
-        )
+        author = find_or_initialize_user_by(email: random_email(suffix: "amendment"))
 
         group = Decidim::UserGroup.create!(
           name: ::Faker::Name.name,
@@ -167,7 +190,7 @@ module Decidim
           scope: random_scope(participatory_space:),
           title: { en: "#{proposal.title["en"]} #{::Faker::Lorem.sentence(word_count: 1)}" },
           body: { en: "#{proposal.body["en"]} #{::Faker::Lorem.sentence(word_count: 3)}" },
-          state: "evaluating",
+          proposal_state: Decidim::Proposals::ProposalState.where(component: proposal.component, token: :evaluating).first,
           answer: nil,
           answered_at: Time.current,
           published_at: Time.current
@@ -196,17 +219,7 @@ module Decidim
       end
 
       def create_proposal_votes!(proposal:, emendation: nil)
-        author = Decidim::User.find_or_initialize_by(email: random_email(suffix: "vote"))
-        author.update!(
-          password: "decidim123456789",
-          name: "#{::Faker::Name.name} #{participatory_space.id}",
-          nickname: random_nickname,
-          organization:,
-          tos_agreement: "1",
-          confirmed_at: Time.current,
-          personal_url: ::Faker::Internet.url,
-          about: ::Faker::Lorem.paragraph(sentence_count: 2)
-        )
+        author = find_or_initialize_user_by(email: random_email(suffix: "vote"))
 
         Decidim::Proposals::ProposalVote.create!(proposal:, author:) unless proposal.published_state? && proposal.rejected?
         Decidim::Proposals::ProposalVote.create!(proposal: emendation, author:) if emendation