decidim-plans 0.16.6 → 0.16.7

data/config/locales/en.yml

@@ -36,6 +36,7 @@ en:
             attachments_allowed: Attachments allowed
             attachment_help: Attachment help text
             categories_enabled: Categories enabled
+            closing_allowed: Allow plan authors to mark the plans as done
             comments_enabled: Comments enabled
             multilingual_answers: Multilingual answers
             plan_answering_enabled: Answering enabled
@@ -58,10 +59,17 @@ en:
     plans:
       actions:
         answer: Answer
+        back: Back
+        confirm_destroy: Are you sure you want to delete this?
         close_plan: Mark as done
+        destroy: Delete
+        edit: Edit
         edit_plan: Edit
         export_budgets: Convert to projects
+        manage_tags: Manage tags
         new: Submit new plan
+        new_tag: New tag
+        plan_taggings: Tags
         reopen_plan: Open for editing
         sections: Sections
         title: Actions
@@ -93,14 +101,24 @@ en:
             title: Edit
             update: Update
           form:
-            attachment_legend: "Add an attachment"
+            attachment_legend: Add an attachment
             select_a_category: Select a category
           index:
+            draft_plans: Drafts
+            published_plans: Published
             selected: Selected
             title: Plans
           new:
             create: Create
             title: Submit new plan
+          taggings:
+            no_results: "Create new tag: %{name}"
+            search: Search
+            title: Tags
+            update: Update
+          update_taggings:
+            invalid: Error updating the tags.
+            success: Tags updated successfully.
         sections:
           form:
             add_section: Add section
@@ -124,6 +142,27 @@ en:
             body: Body
             created_at: Creation date
             plans: Plans
+        tags:
+          create:
+            error: Failed to create.
+            success: Created successfully.
+          destroy:
+            error: Error deleting.
+            success: Deleted successfully.
+          edit:
+            title: Edit tag
+            update: Update
+          form:
+            tags: Tags
+          index:
+            tags: Tags
+            title: Manage tags
+          new:
+            create: Create
+            title: New tag
+          update:
+            invalid: Error updating.
+            success: Updated successfully.
       admin_log:
         plan:
           answer: "%{user_name} answered %{resource_name} on the %{space_name}
@@ -175,7 +214,13 @@ en:
             published_at: Published at
             scope: Scope
             state: State
+            tags: Tags
             title: Title
+        plan_tags:
+          fields:
+            id: ID
+            name: Name
+            taggings_count: Number of uses
       plans:
         attached_proposals:
           attached_proposals: Attached proposals
@@ -193,6 +238,13 @@ en:
           discard: Discard this draft
           discard_confirmation: Are you sure you want to discard this draft?
           update: Update
+        evaluation_modal:
+          button_text: OK
+          close: Close modal
+          description: The plan is being evaluated and it cannot be edited
+            during this time. You will get notified once the evaluation is
+            completed.
+          title: The plan is being evaluated
         preview:
           modify: Modify
           publish: Publish
@@ -211,6 +263,8 @@ en:
           related_to: Related to
           search: Search
           state: State
+          tag: Tags
+          tag_prompt: Select tags
           voted: Voted
         filters_small_view:
           close_modal: Close modal
@@ -218,7 +272,7 @@ en:
           filter_by: Filter by
           unfold: Unfold
         form:
-          attachment_legend: "Add an attachment"
+          attachment_legend: Add an attachment
           select_a_category: Select a category
         index:
           new_plan: New plan
@@ -261,6 +315,7 @@ en:
           plan_accepted_reason: 'This plan has been accepted because:'
           plan_in_evaluation_reason: This plan is being evaluated
           plan_rejected_reason: 'This plan has been rejected because:'
+          plan_waiting_for_evaluation: The plan is being evaluated, editing not allowed.
           publish: Publish
           publish_info: Publish this version of the draft or
           published_proposal: published plan

data/config/locales/fi.yml

@@ -33,13 +33,16 @@ fi:
           global:
             announcement: Ilmoitus
             attachments_allowed: Liitteet sallittu
+            attachment_help: Liitteen ohjeteksti
             categories_enabled: Kategoriat käytössä
+            closing_allowed: Salli suunnitelmien laatijoiden merkata suunnitelmia valmiiksi
             comments_enabled: Kommentointi sallittu
             multilingual_answers: Monikieliset vastaukset
             plan_answering_enabled: Vastaaminen sallittu
             plan_title_length: Otsikon pituus
             proposal_linking_enabled: Ehdotusten linkkaaminen käytössä
             scopes_enabled: Teemat käytössä
+            title_help: Otsikon ohjeteksti
           step:
             announcement: Ilmoitus
             comments_blocked: Kommentointi estetty
@@ -55,10 +58,17 @@ fi:
     plans:
       actions:
         answer: Vastaa
+        back: Takaisin
+        confirm_destroy: Oletko varma että haluat poistaa tämän kohteen?
         close_plan: Merkitse valmiiksi
+        destroy: Poista
+        edit: Muokkaa
         edit_plan: Muokkaa
         export_budgets: Muunna projekteiksi
+        manage_tags: Hallinnoi merkintöjä
         new: Tee uusi suunnitelma
+        new_tag: Uusi merkintä
+        plan_taggings: Merkinnät
         reopen_plan: Avaa muokattavaksi
         sections: Osiot
         title: Toiminnot
@@ -90,14 +100,24 @@ fi:
             title: Muokkaa
             update: Päivitä
           form:
-            attachment_legend: "Lisää liite"
+            attachment_legend: Lisää liite
             select_a_category: Valitse kategoria
           index:
+            draft_plans: Luonnoksia
+            published_plans: Julkaistuja
             selected: Valittu
             title: Suunnitelmat
           new:
             create: Luo
             title: Tee uusi suunnitelma
+          taggings:
+            no_results: "Luo uusi merkintä: %{name}"
+            search: Hae
+            title: Merkinnät
+            update: Päivitä
+          update_taggings:
+            invalid: Virhe päivitettäessä merkintöjä.
+            success: Merkintöjen päivitys onnistui.
         sections:
           form:
             add_section: Lisää osio
@@ -121,6 +141,27 @@ fi:
             body: Runkoteksti
             created_at: Luontipäivä
             plans: Suunnitelmat
+        tags:
+          create:
+            error: Luonti epäonnistui.
+            success: Luonti onnistui.
+          destroy:
+            error: Virhe poistettaessa.
+            success: Poisto onnistui.
+          edit:
+            title: Muokkaa merkintää
+            update: Päivitä
+          form:
+            tags: Merkinnät
+          index:
+            tags: Merkinnät
+            title: Hallinnoi merkintöjä
+          new:
+            create: Luo
+            title: Uusi merkintä
+          update:
+            invalid: Virhe päivitettäessä.
+            success: Päivitys onnistui.
       admin_log:
         plan:
           answer: "%{user_name} vastasi sisältöön %{resource_name} osallisuustilassa %{space_name}."
@@ -168,7 +209,13 @@ fi:
             published_at: Julkaisuajankohta
             scope: Teema
             state: Tila
+            tags: Merkinnät
             title: Otsikko
+        plan_tags:
+          fields:
+            id: ID
+            name: Nimi
+            taggings_count: Käyttömäärä
       plans:
         attached_proposals:
           attached_proposals: Liitetyt ehdotukset
@@ -186,6 +233,11 @@ fi:
           discard: Tuhoa tämä luonnos
           discard_confirmation: Haluatko varmasti tuhota tämän luonnoksen?
           update: Päivitä
+        evaluation_modal:
+          button_text: OK
+          close: Sulje ikkuna
+          description: Suunnitelmaa arvioidaan ja sitä ei voi muokata tällä hetkellä. Saat ilmoituksen, kun arviointi valmistuu.
+          title: Suunnitelmaa arvioidaan
         preview:
           modify: Muokkaa
           publish: Julkaise
@@ -204,6 +256,8 @@ fi:
           related_to: Liittyy kohteeseen
           search: Hae
           state: Tila
+          tag: Merkinnät
+          tag_prompt: Valitse merkinnät
           voted: Kannatettu
         filters_small_view:
           close_modal: Sulje ikkuna
@@ -211,7 +265,7 @@ fi:
           filter_by: Suodata
           unfold: Avaa
         form:
-          attachment_legend: "Lisää liite"
+          attachment_legend: Lisää liite
           select_a_category: Valitse kategoria
         index:
           new_plan: Uusi suunnitelma
@@ -252,6 +306,7 @@ fi:
           plan_accepted_reason: 'Tämä suunnitelma on hyväksytty, koska:'
           plan_in_evaluation_reason: Tämä suunnitelma on arvioitavana
           plan_rejected_reason: 'Tämä suunnitelma on hylätty, koska:'
+          plan_waiting_for_evaluation: Suunnitelma on arvioinnissa, muokkaaminen estetty.
           publish: Julkaise
           publish_info: Julkaise tämä luonnosversio tai
           published_proposal: julkaistu suunnitelma

data/config/locales/sv.yml

@@ -33,13 +33,16 @@ sv:
           global:
             announcement: Meddelande
             attachments_allowed: Bilagor tillåtna
+            attachment_help: Bilag hjälptext
             categories_enabled: Kategorier aktiverade
+            closing_allowed: Tillåta plan författarna att markera planerna som gjort
             comments_enabled: Kommentarer tillåtna
             multilingual_answers: Flerspråkiga svar
             plan_answering_enabled: Svar tillåtna
             plan_title_length: Rubrikens längd
             proposal_linking_enabled: Förslagslänk aktiverat
             scopes_enabled: Omfattningar aktiverade
+            title_help: Titel hjälptext
           step:
             announcement: Meddelande
             comments_blocked: Kommentarer blockerade
@@ -55,10 +58,17 @@ sv:
     plans:
       actions:
         answer: Svara
+        back: Tillbaka
+        confirm_destroy: Är du säker på att du vill ta bort objektet?
         close_plan: Markera som gjort
+        destroy: Ta bort
+        edit: Redigera
         edit_plan: Redigera
         export_budgets: Konvertera till projekt
+        manage_tags: Hantera taggar
         new: Gör ny plan
+        new_tag: Ny tagg
+        plan_taggings: Taggar
         reopen_plan: Öppna för redigering
         sections: Avsnitt
         title: Funktioner
@@ -90,14 +100,24 @@ sv:
             title: Redigera
             update: Uppdatera
           form:
-            attachment_legend: "Lägg till bilaga"
+            attachment_legend: Lägg till bilaga
             select_a_category: Välj kategori
           index:
+            draft_plans: Utkast
+            published_plans: Publicerad
             selected: Vald
             title: Planer
           new:
             create: Skapa
             title: Gör ny plan
+          taggings:
+            no_results: "Skapa ny tagg: %{name}"
+            search: Sök
+            title: Taggar
+            update: Uppdatera
+          update_taggings:
+            invalid: Fel vid uppdatering av taggarna.
+            success: Taggar uppdaterats.
         sections:
           form:
             add_section: Lägg till avsnitt
@@ -121,6 +141,27 @@ sv:
             body: Brödtext
             created_at: Skapats
             plans: Planer
+        tags:
+          create:
+            error: Det gick inte att skapa.
+            success: Skapats.
+          destroy:
+            error: Fel vid borttagning.
+            success: Innehållet har raderats.
+          edit:
+            title: Redigera tagg
+            update: Uppdatera
+          form:
+            tags: Taggar
+          index:
+            tags: Taggar
+            title: Hantera taggar
+          new:
+            create: Skapa
+            title: Ny tagg
+          update:
+            invalid: Fel uppdatering.
+            success: Uppdaterats.
       admin_log:
         plan:
           answer: "%{user_name} svarade på innehållet %{resource_name} i delaktighetslokalen %{space_name}."
@@ -168,7 +209,13 @@ sv:
             published_at: Publikationsdatum
             scope: Tema
             state: Status
+            tags: Taggar
             title: Rubrik
+        plan_tags:
+          fields:
+            id: ID
+            name: Namn
+            taggings_count: Antal användningsområden
       plans:
         attached_proposals:
           attached_proposals: Bifogade förslag
@@ -186,6 +233,11 @@ sv:
           discard: Radera utkastet
           discard_confirmation: Är du säker på att du vill radera utkastet?
           update: Uppdatera
+        evaluation_modal:
+          button_text: OK
+          close: Stäng fönstret
+          description: Planen utvärderas och den kan inte redigeras under denna tid. Du kommer att få meddelande när utvärderingen är klar.
+          title: Planen beräknas
         preview:
           modify: Redigera
           publish: Publicera
@@ -204,6 +256,8 @@ sv:
           related_to: Anknyter till
           search: Sök
           state: Status
+          tag: Taggar
+          tag_prompt: Välj taggar
           voted: Understödd
         filters_small_view:
           close_modal: Stäng fönstret
@@ -211,7 +265,7 @@ sv:
           filter_by: Filtrera
           unfold: Öppna
         form:
-          attachment_legend: "Lägg till bilaga"
+          attachment_legend: Lägg till bilaga
           select_a_category: Välj kategori
         index:
           new_plan: Ny plan
@@ -252,6 +306,7 @@ sv:
           plan_accepted_reason: 'Planen har godkänts eftersom:'
           plan_in_evaluation_reason: Planen bedöms
           plan_rejected_reason: 'Planen har avslagits eftersom:'
+          plan_waiting_for_evaluation: Planen beräknas, redigering är inte tillåten.
           publish: Publicera
           publish_info: Publicera detta utkast eller
           published_proposal: publicerad plan

data/db/migrate/20190329161710_fix_plan_closing_workflow_states.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class FixPlanClosingWorkflowStates < ActiveRecord::Migration[5.2]
+  def up
+    Decidim::Plans::Plan.all.each do |plan|
+      if plan.closed? && !plan.answered?
+        plan.update!(state: "evaluating")
+      elsif !plan.closed? && plan.answered?
+        plan.update!(closed_at: plan.answered_at)
+      end
+    end
+  end
+end

data/db/migrate/20190331141058_create_decidim_plans_tags_and_plan_taggings.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateDecidimPlansTagsAndPlanTaggings < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_plans_tags do |t|
+      t.jsonb :name
+      t.timestamps
+      t.references :decidim_organization, foreign_key: true, index: true, null: false
+    end
+
+    create_table :decidim_plans_plan_taggings do |t|
+      t.datetime :created_at
+      t.references :decidim_plans_tag, index: true
+      t.references :decidim_plan, index: true
+    end
+  end
+end

data/lib/decidim/content_parsers/plan_parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentParsers
+    # A parser that searches mentions of Plans in content.
+    #
+    # This parser accepts one way for linking Plans:
+    # - Using a standard url starting with http or https.
+    #
+    # Also fills a `Metadata#linked_plans` attribute.
+    #
+    # @see BaseParser Examples of how to use a content parser
+    class PlanParser < BaseParser
+      # Class used as a container for metadata
+      #
+      # @!attribute linked_plans
+      #   @return [Array] an array of Decidim::Plans::Plan mentioned in content
+      Metadata = Struct.new(:linked_plans)
+
+      # Matches a URL
+      URL_REGEX_SCHEME = '(?:http(s)?:\/\/)'
+      URL_REGEX_CONTENT = '[\w.-]+[\w\-\._~:\/?#\[\]@!\$&\'\(\)\*\+,;=.]+'
+      URL_REGEX_END_CHAR = '[\d]'
+      URL_REGEX = %r{#{URL_REGEX_SCHEME}#{URL_REGEX_CONTENT}/plans/#{URL_REGEX_END_CHAR}+}i
+      # Matches a mentioned Proposal ID (~(d)+ expression)
+      ID_REGEX = /~(\d+)/
+
+      def initialize(content, context)
+        super
+        @metadata = Metadata.new([])
+      end
+
+      # Replaces found mentions matching an existing Plan with a global id for
+      # that Plan. Other mentions found that doesn't match an existing Plan
+      # are returned as they are.
+      #
+      # @return [String] the content with the valid mentions replaced by a
+      #                  global id.
+      def rewrite
+        parse_for_urls(content)
+      end
+
+      # (see BaseParser#metadata)
+      attr_reader :metadata
+
+      private
+
+      def parse_for_urls(content)
+        content.gsub(URL_REGEX) do |match|
+          plan = plan_from_url_match(match)
+          if plan
+            @metadata.linked_plans << plan.id
+            plan.to_global_id
+          else
+            match
+          end
+        end
+      end
+
+      def plan_from_url_match(match)
+        uri = URI.parse(match)
+        return if uri.path.blank?
+
+        plan_id = uri.path.split("/").last
+        find_plan_by_id(plan_id)
+      rescue URI::InvalidURIError
+        Rails.logger.error("#{e.message}=>#{e.backtrace}")
+        nil
+      end
+
+      def find_plan_by_id(id)
+        if id.present?
+          spaces = Decidim.participatory_space_manifests.flat_map do |manifest|
+            manifest.participatory_spaces.call(context[:current_organization]).public_spaces
+          end
+          components = Component.where(participatory_space: spaces).published
+          Decidim::Plans::Plan.where(component: components).find_by(id: id)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/content_renderers/plan_renderer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    # A renderer that searches Global IDs representing plans in content
+    # and replaces it with a link to their show page.
+    #
+    # e.g. gid://<APP_NAME>/Decidim::Plans::Plan/1
+    #
+    # @see BaseRenderer Examples of how to use a content renderer
+    class PlanRenderer < BaseRenderer
+      # Matches a global id representing a Decidim::User
+      GLOBAL_ID_REGEX = %r{gid:\/\/([\w-]*\/Decidim::Plans::Plan\/(\d+))}i
+
+      # Replaces found Global IDs matching an existing plan with
+      # a link to its show page. The Global IDs representing an
+      # invalid Decidim::Plans::Plan are replaced with '???' string.
+      #
+      # @return [String] the content ready to display (contains HTML)
+      def render
+        content.gsub(GLOBAL_ID_REGEX) do |plan_gid|
+          begin
+            plan = GlobalID::Locator.locate(plan_gid)
+            Decidim::Plans::PlanPresenter.new(plan).display_mention
+          rescue ActiveRecord::RecordNotFound
+            plan_gid = plan_gid.split("/").last
+            "##{plan_gid}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/plans/admin_engine.rb

@@ -13,7 +13,10 @@ module Decidim
         resources :plans, only: [:index, :new, :create, :edit, :update] do
           get :search_proposals
           resources :plan_answers, only: [:edit, :update]
+          resources :tags, except: [:show]
           member do
+            get :taggings
+            patch :update_taggings
             post :close
             post :reopen
           end

data/lib/decidim/plans/component.rb

@@ -28,6 +28,7 @@ Decidim.register_component(:plans) do |component|
     settings.attribute :categories_enabled, type: :boolean, default: true
     settings.attribute :proposal_linking_enabled, type: :boolean, default: true
     settings.attribute :attachments_allowed, type: :boolean, default: false
+    settings.attribute :closing_allowed, type: :boolean, default: false
     settings.attribute :multilingual_answers, type: :boolean
   end
 
@@ -127,13 +128,20 @@ Decidim.register_component(:plans) do |component|
       state, answer = if n > 3
                         ["accepted", Decidim::Faker::Localized.sentence(10)]
                       elsif n > 2
-                        ["rejected", nil]
+                        ["rejected", Decidim::Faker::Localized.sentence(10)]
                       elsif n > 1
                         ["evaluating", nil]
                       else
                         [nil, nil]
                       end
 
+      # Check whether the plan is answered and set it closed by random if not.
+      is_answered = !state.nil?
+      is_closed = is_answered || rand < 0.5
+
+      # Force the state to be "evaluating" for closed but unanswered plans
+      state = "evaluating" if is_closed && !is_answered
+
       params = {
         component: component,
         category: participatory_space.categories.sample,
@@ -141,7 +149,8 @@ Decidim.register_component(:plans) do |component|
         title: Decidim::Faker::Localized.sentence(2),
         state: state,
         answer: answer,
-        answered_at: Time.current,
+        closed_at: is_closed ? Time.current : nil,
+        answered_at: is_answered ? Time.current : nil,
         published_at: Time.current
       }
 

data/lib/decidim/plans/engine.rb

@@ -39,6 +39,12 @@ module Decidim
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Plans::Engine.root}/app/cells")
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Plans::Engine.root}/app/views") # for partials
       end
+
+      initializer "decidim_plans.content_processors" do |_app|
+        Decidim.configure do |config|
+          config.content_processors += [:plan]
+        end
+      end
     end
   end
 end

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

@@ -41,6 +41,14 @@ FactoryBot.define do
       end
     end
 
+    trait :with_closing_allowed do
+      settings do
+        {
+          closing_allowed: true
+        }
+      end
+    end
+
     trait :with_multilingual_answers do
       settings do
         {
@@ -69,6 +77,7 @@ FactoryBot.define do
       plan_proposals { nil }
       # user_groups correspondence to users is by sorting order
       user_groups { [] }
+      tags { [] }
     end
 
     title { generate_localized_title }
@@ -87,6 +96,9 @@ FactoryBot.define do
         proposals = evaluator.plan_proposals || [create(:proposal, component: proposal_component)]
         plan.attached_proposals = proposals.map { |p| create(:attached_proposal, plan: plan, proposal: p) }
       end
+      if evaluator.tags && evaluator.tags.count > 0
+        plan.update!(tags: evaluator.tags)
+      end
     end
 
     trait :published do
@@ -142,4 +154,9 @@ FactoryBot.define do
     plan
     user
   end
+
+  factory :tag, class: "Decidim::Plans::Tag" do
+    name { generate_localized_title }
+    organization { create(:organization) }
+  end
 end

data/lib/decidim/plans/version.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   module Plans
-    VERSION = "0.16.6"
+    VERSION = "0.16.7"
     DECIDIM_VERSION = "~> 0.16.0"
   end
 end

data/lib/decidim/plans.rb

@@ -23,4 +23,12 @@ module Decidim
       @tracer ||= Tracer.new
     end
   end
+
+  module ContentParsers
+    autoload :PlanParser, "decidim/content_parsers/plan_parser"
+  end
+
+  module ContentRenderers
+    autoload :PlanRenderer, "decidim/content_renderers/plan_renderer"
+  end
 end