decidim-proposals 0.14.4 → 0.15.0

data/lib/decidim/proposals.rb

@@ -4,6 +4,7 @@ require "decidim/proposals/admin"
 require "decidim/proposals/engine"
 require "decidim/proposals/admin_engine"
 require "decidim/proposals/component"
+require "acts_as_list"
 
 module Decidim
   # This namespace holds the logic of the `Proposals` component. This component
@@ -12,7 +13,8 @@ module Decidim
     autoload :ProposalSerializer, "decidim/proposals/proposal_serializer"
     autoload :CommentableProposal, "decidim/proposals/commentable_proposal"
     autoload :CommentableCollaborativeDraft, "decidim/proposals/commentable_collaborative_draft"
-    autoload :ViewModel, "decidim/proposals/view_model"
+    autoload :MarkdownToProposals, "decidim/proposals/markdown_to_proposals"
+    autoload :ParticipatoryTextSection, "decidim/proposals/participatory_text_section"
 
     include ActiveSupport::Configurable
 

data/lib/decidim/proposals/admin_engine.rb

@@ -10,14 +10,25 @@ module Decidim
       paths["lib/tasks"] = nil
 
       routes do
-        resources :proposals, only: [:index, :new, :create] do
+        resources :proposals, only: [:index, :new, :create, :edit, :update] do
           post :update_category, on: :collection
           collection do
             resource :proposals_import, only: [:new, :create]
+            resource :proposals_merge, only: [:create]
+            resource :proposals_split, only: [:create]
           end
           resources :proposal_answers, only: [:edit, :update]
           resources :proposal_notes, only: [:index, :create]
         end
+        scope "/proposal_components/:component_id" do
+          resources :participatory_texts, only: :index do
+            collection do
+              get :new_import
+              post :import
+              post :publish
+            end
+          end
+        end
 
         root to: "proposals#index"
       end

data/lib/decidim/proposals/component.rb

@@ -21,6 +21,7 @@ Decidim.register_component(:proposals) do |component|
 
   component.settings(:global) do |settings|
     settings.attribute :vote_limit, type: :integer, default: 0
+    settings.attribute :minimum_votes_per_user, type: :integer, default: 0
     settings.attribute :proposal_limit, type: :integer, default: 0
     settings.attribute :proposal_length, type: :integer, default: 500
     settings.attribute :proposal_edit_before_minutes, type: :integer, default: 5
@@ -33,6 +34,7 @@ Decidim.register_component(:proposals) do |component|
     settings.attribute :attachments_allowed, type: :boolean, default: false
     settings.attribute :resources_permissions_enabled, type: :boolean, default: true
     settings.attribute :collaborative_drafts_enabled, type: :boolean, default: false
+    settings.attribute :participatory_texts_enabled, type: :boolean, default: false
     settings.attribute :announcement, type: :text, translated: true, editor: true
     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
@@ -110,13 +112,18 @@ Decidim.register_component(:proposals) do |component|
   end
 
   component.seeds do |participatory_space|
+    admin_user = Decidim::User.find_by(
+      organization: participatory_space.organization,
+      email: "admin@example.org"
+    )
+
     step_settings = if participatory_space.allows_steps?
                       { participatory_space.active_step.id => { votes_enabled: true, votes_blocked: false, creation_enabled: true } }
                     else
                       {}
                     end
 
-    component = Decidim::Component.create!(
+    params = {
       name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :proposals).i18n_name,
       manifest_name: :proposals,
       published_at: Time.current,
@@ -126,7 +133,16 @@ Decidim.register_component(:proposals) do |component|
         collaborative_drafts_enabled: true
       },
       step_settings: step_settings
-    )
+    }
+
+    component = Decidim.traceability.perform_action!(
+      "publish",
+      Decidim::Component,
+      admin_user,
+      visibility: "all"
+    ) do
+      Decidim::Component.create!(params)
+    end
 
     if participatory_space.scope
       scopes = participatory_space.scope.descendants
@@ -147,7 +163,7 @@ Decidim.register_component(:proposals) do |component|
                         [nil, nil]
                       end
 
-      proposal = Decidim::Proposals::Proposal.create!(
+      params = {
         component: component,
         category: participatory_space.categories.sample,
         scope: Faker::Boolean.boolean(0.5) ? global : scopes.sample,
@@ -157,10 +173,23 @@ Decidim.register_component(:proposals) do |component|
         answer: answer,
         answered_at: Time.current,
         published_at: Time.current
-      )
+      }
+
+      proposal = Decidim.traceability.perform_action!(
+        "publish",
+        Decidim::Proposals::Proposal,
+        admin_user,
+        visibility: "all"
+      ) do
+        proposal = Decidim::Proposals::Proposal.new(params)
+        proposal.add_coauthor(participatory_space.organization)
+        proposal.save!
+        proposal
+      end
+
       if n.positive?
         Decidim::User.where(decidim_organization_id: participatory_space.decidim_organization_id).all.sample(n).each do |author|
-          user_group = [true, false].sample ? author.user_groups.verified.sample : nil
+          user_group = [true, false].sample ? Decidim::UserGroups::ManageableUserGroups.for(author).verified.sample : nil
           proposal.add_coauthor(author, user_group: user_group)
         end
       end
@@ -203,13 +232,19 @@ Decidim.register_component(:proposals) do |component|
           if index.even?
             group = Decidim::UserGroup.create!(
               name: Faker::Name.name,
-              document_number: Faker::Code.isbn,
-              phone: Faker::PhoneNumber.phone_number,
-              decidim_organization_id: component.organization.id,
-              verified_at: Time.current
+              nickname: Faker::Twitter.unique.screen_name,
+              extended_data: {
+                document_number: Faker::Code.isbn,
+                phone: Faker::PhoneNumber.phone_number,
+                verified_at: Time.current
+              },
+              decidim_organization_id: component.organization.id
+            )
+            Decidim::UserGroupMembership.create!(
+              user: author,
+              role: "creator",
+              user_group: group
             )
-            author.user_groups << group
-            author.save!
           end
           Decidim::Proposals::ProposalEndorsement.create!(proposal: proposal, author: author, user_group: author.user_groups.first)
         end
@@ -239,18 +274,20 @@ Decidim.register_component(:proposals) do |component|
               end
       author = Decidim::User.where(organization: component.organization).all.sample
 
-      draft = Decidim.traceability.create!(
-        Decidim::Proposals::CollaborativeDraft,
-        author,
-        component: component,
-        category: participatory_space.categories.sample,
-        scope: Faker::Boolean.boolean(0.5) ? global : scopes.sample,
-        title: Faker::Lorem.sentence(2),
-        body: Faker::Lorem.paragraphs(2).join("\n"),
-        state: state,
-        published_at: Time.current
-      )
-      Decidim::Coauthorship.create(coauthorable: draft, author: author)
+      draft = Decidim.traceability.perform_action!("create", Decidim::Proposals::CollaborativeDraft, author) do
+        draft = Decidim::Proposals::CollaborativeDraft.new(
+          component: component,
+          category: participatory_space.categories.sample,
+          scope: Faker::Boolean.boolean(0.5) ? global : scopes.sample,
+          title: Faker::Lorem.sentence(2),
+          body: Faker::Lorem.paragraphs(2).join("\n"),
+          state: state,
+          published_at: Time.current
+        )
+        draft.coauthorships.build(author: participatory_space.organization)
+        draft.save!
+        draft
+      end
 
       if n == 2
         author2 = Decidim::User.where(organization: component.organization).all.sample

data/lib/decidim/proposals/engine.rb

@@ -113,8 +113,8 @@ module Decidim
 
       initializer "decidim_proposals.mentions_listener" do
         Decidim::Comments::CommentCreation.subscribe do |data|
-          metadata = data[:metadatas][:proposals]
-          Decidim::Proposals::NotifyProposalsMentionedJob.perform_later(data[:comment_id], metadata)
+          proposals = data.dig(:metadatas, :proposal).try(:linked_proposals)
+          Decidim::Proposals::NotifyProposalsMentionedJob.perform_later(data[:comment_id], proposals) if proposals
         end
       end
 
@@ -140,22 +140,42 @@ module Decidim
         Decidim::Gamification.register_badge(:proposals) do |badge|
           badge.levels = [1, 5, 10, 30, 60]
 
-          badge.reset = lambda { |user|
-            Decidim::Coauthorship.where(
-              coauthorable_type: "Decidim::Proposals::Proposal",
-              author: user
-            ).count
+          badge.valid_for = [:user, :user_group]
+
+          badge.reset = lambda { |model|
+            if model.is_a?(User)
+              Decidim::Coauthorship.where(
+                coauthorable_type: "Decidim::Proposals::Proposal",
+                author: model,
+                user_group: nil
+              ).count
+            elsif model.is_a?(UserGroup)
+              Decidim::Coauthorship.where(
+                coauthorable_type: "Decidim::Proposals::Proposal",
+                user_group: model
+              ).count
+            end
           }
         end
 
         Decidim::Gamification.register_badge(:accepted_proposals) do |badge|
           badge.levels = [1, 5, 15, 30, 50]
 
-          badge.reset = lambda { |user|
-            proposal_ids = Decidim::Coauthorship.where(
-              coauthorable_type: "Decidim::Proposals::Proposal",
-              author: user
-            ).select(:coauthorable_id)
+          badge.valid_for = [:user, :user_group]
+
+          badge.reset = lambda { |model|
+            proposal_ids = if model.is_a?(User)
+                             Decidim::Coauthorship.where(
+                               coauthorable_type: "Decidim::Proposals::Proposal",
+                               author: model,
+                               user_group: nil
+                             ).select(:coauthorable_id)
+                           elsif model.is_a?(UserGroup)
+                             Decidim::Coauthorship.where(
+                               coauthorable_type: "Decidim::Proposals::Proposal",
+                               user_group: model
+                             ).select(:coauthorable_id)
+                           end
 
             Decidim::Proposals::Proposal.where(id: proposal_ids).accepted.count
           }
@@ -169,6 +189,29 @@ module Decidim
           }
         end
       end
+
+      initializer "decidim_proposals.register_metrics" do
+        Decidim.metrics_registry.register(
+          :proposals,
+          "Decidim::Proposals::Metrics::ProposalsMetricManage",
+          Decidim::MetricRegistry::HIGHLIGHTED,
+          2
+        )
+
+        Decidim.metrics_registry.register(
+          :accepted_proposals,
+          "Decidim::Proposals::Metrics::AcceptedProposalsMetricManage",
+          Decidim::MetricRegistry::NOT_HIGHLIGHTED,
+          3
+        )
+
+        Decidim.metrics_registry.register(
+          :votes,
+          "Decidim::Proposals::Metrics::VotesMetricManage",
+          Decidim::MetricRegistry::HIGHLIGHTED,
+          3
+        )
+      end
     end
   end
 end

data/lib/decidim/proposals/markdown_to_proposals.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "redcarpet"
+
+module Decidim
+  module Proposals
+    # This class parses a participatory text document in markdown and
+    # produces Proposals in the form of sections and articles.
+    #
+    # This implementation uses Redcarpet Base renderer.
+    # Redcarpet::Render::Base performs a callback for every block it finds, what MarkdownToProposals
+    # does is to implement callbacks for the blocks which it is interested in performing some actions.
+    #
+    class MarkdownToProposals < ::Redcarpet::Render::Base
+      # Public: Initializes the serializer with a proposal.
+      def initialize(component, current_user)
+        super()
+        @component = component
+        @current_user = current_user
+        @last_position = 0
+        @num_sections = 0
+      end
+
+      def parse(document)
+        renderer = self
+        parser = ::Redcarpet::Markdown.new(renderer)
+        parser.render(document)
+      end
+
+      ##########################################
+      # Redcarpet callbacks
+      ##########################################
+
+      # Recarpet callback to process headers.
+      # Creates Paricipatory Text Proposals at Section and Subsection levels.
+      def header(title, level)
+        participatory_text_level = if level > 1
+                                     Decidim::Proposals::ParticipatoryTextSection::LEVELS[:sub_section]
+                                   else
+                                     Decidim::Proposals::ParticipatoryTextSection::LEVELS[:section]
+                                   end
+
+        create_proposal(title, title, participatory_text_level)
+
+        @num_sections += 1
+        title
+      end
+
+      # Recarpet callback to process paragraphs.
+      # Creates Paricipatory Text Proposals at Article level.
+      def paragraph(text)
+        return if text.blank?
+
+        create_proposal(
+          (@last_position + 1 - @num_sections).to_s,
+          text,
+          Decidim::Proposals::ParticipatoryTextSection::LEVELS[:article]
+        )
+
+        text
+      end
+
+      # ignore images
+      def image(_link, _title, _alt_text)
+        ""
+      end
+
+      private
+
+      def create_proposal(title, body, participatory_text_level)
+        attributes = {
+          component: @component,
+          title: title,
+          body: body,
+          participatory_text_level: participatory_text_level
+        }
+
+        proposal = Decidim::Proposals::ProposalBuilder.create(
+          attributes: attributes,
+          author: @component.organization,
+          action_user: @current_user
+        )
+
+        @last_position = proposal.position
+
+        proposal
+      end
+    end
+  end
+end

data/lib/decidim/proposals/participatory_text_section.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # The data store for a Proposal in the Decidim::Proposals component.
+    module ParticipatoryTextSection
+      extend ActiveSupport::Concern
+
+      LEVELS = {
+        section: "section", sub_section: "sub-section", article: "article"
+      }.freeze
+
+      included do
+        # Public: is this section an :article?
+        def article?
+          participatory_text_level == LEVELS[:article]
+        end
+      end
+    end
+  end
+end

data/lib/decidim/proposals/test/factories.rb

@@ -158,6 +158,25 @@ FactoryBot.define do
         }
       end
     end
+
+    trait :with_minimum_votes_per_user do
+      transient do
+        minimum_votes_per_user { 3 }
+      end
+
+      settings do
+        {
+          minimum_votes_per_user: minimum_votes_per_user
+        }
+      end
+    end
+    trait :with_participatory_texts_enabled do
+      settings do
+        {
+          participatory_texts_enabled: true
+        }
+      end
+    end
   end
 
   factory :proposal, class: "Decidim::Proposals::Proposal" do
@@ -167,7 +186,7 @@ FactoryBot.define do
       user_groups { [] }
     end
 
-    title { Faker::Lorem.sentence }
+    title { generate(:title) }
     body { Faker::Lorem.sentences(3).join("\n") }
     component { create(:proposal_component) }
     published_at { Time.current }
@@ -178,14 +197,23 @@ FactoryBot.define do
         users = evaluator.users || [create(:user, organization: proposal.component.participatory_space.organization)]
         users.each_with_index do |user, idx|
           user_group = evaluator.user_groups[idx]
-          Decidim::Coauthorship.create(author: user, user_group: user_group, coauthorable: proposal)
+          proposal.coauthorships.build(author: user, user_group: user_group)
         end
       end
     end
 
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :unpublished do
+      published_at { nil }
+    end
+
     trait :official do
       after :build do |proposal|
         proposal.coauthorships.clear
+        proposal.coauthorships.build(author: proposal.organization)
       end
     end
 
@@ -210,7 +238,7 @@ FactoryBot.define do
 
     trait :with_answer do
       state { "accepted" }
-      answer { Decidim::Faker::Localized.sentence }
+      answer { generate_localized_title }
       answered_at { Time.current }
     end
 
@@ -219,8 +247,8 @@ FactoryBot.define do
     end
 
     trait :hidden do
-      moderation do
-        create(:moderation, hidden_at: Time.current)
+      after :create do |proposal|
+        create(:moderation, hidden_at: Time.current, reportable: proposal)
       end
     end
 
@@ -266,7 +294,7 @@ FactoryBot.define do
       user_groups { [] }
     end
 
-    title { Faker::Lorem.sentence }
+    title { generate(:title) }
     body { Faker::Lorem.sentences(3).join("\n") }
     component { create(:proposal_component) }
     address { "#{Faker::Address.street_name}, #{Faker::Address.city}" }
@@ -277,7 +305,7 @@ FactoryBot.define do
         users = evaluator.users || [create(:user, organization: collaborative_draft.component.participatory_space.organization)]
         users.each_with_index do |user, idx|
           user_group = evaluator.user_groups[idx]
-          Decidim::Coauthorship.create(author: user, user_group: user_group, coauthorable: collaborative_draft)
+          collaborative_draft.coauthorships.build(author: user, user_group: user_group)
         end
       end
     end