decidim-plans 0.16.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f496c0cd1c6ee3f73085fc296508701d44434eb5a1c9dc3375c33ac99ea3a45
-  data.tar.gz: 2893280cdc00ae08eb9096e94da371496e43a2d993ea49ef6345def50a767176
+  metadata.gz: a0beab872d687c4002db352e84e5de788545493a03a5c9e06d22af045d014a10
+  data.tar.gz: b422c03351c34cb8919b22bef233b85451c808edaf90b638e213d027493f2484
 SHA512:
-  metadata.gz: 2751ff4b10252cf2b3bbf59deccb36692b7866dcd9ec90d649b3ca0cb640812601c2fa4ab938228a5425b8a4c96adfd9cd6ca71b147bcaa9834a2df4a815ccd3
-  data.tar.gz: f2db56458ab76aade2d06b91e67061b6bdd857e33a848ae720579fe851e18b3007e4f89847cb51aa71daf8c50947ba0d926b33aac09b4315f7d35788869a4ebf
+  metadata.gz: e3a45ded830363d9e5c1bffe7f9f22b52fff04f62ba8f5d2dea1cb44cf22a716466ce945c67b5bf9f8230becc3102add69f7196fc90f36cb4fb3207fb0b3e9ec
+  data.tar.gz: 5fc28c2575d607f354eb8fe677f9d33886239b948614c939b04f40ddfc095a816c61d0cfaa272af340922184d3c32fe418a956c92163626c83f0989dc5fb1ee8

data/README.md

@@ -1,5 +1,10 @@
 # Decidim::Plans
 
+[![Build Status](https://travis-ci.com/mainio/decidim-module-plans.svg?branch=master)](https://travis-ci.com/mainio/decidim-module-plans)
+[![codecov](https://codecov.io/gh/mainio/decidim-module-plans/branch/master/graph/badge.svg)](https://codecov.io/gh/mainio/decidim-module-plans)
+
+The gem has been developed by [Mainio Tech](https://www.mainiotech.fi/).
+
 A [Decidim](https://github.com/decidim/decidim) module that provides a new
 component that can be added to any participatory space in Decidim. The component
 allows users to write plans together that link to specific proposals. Further on
@@ -26,6 +31,9 @@ following differences:
   converted to sub-headings in the budgeting project's description and the
   budget needs to be specified by the user doing the conversion.
 
+Development of this gem has been sponsored by the
+[City of Helsinki](https://www.hel.fi/).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/app/assets/javascripts/decidim/plans/proposal_picker.js.es6

@@ -4,38 +4,58 @@
 // = require_self
 
 $(function() {
-  $(document).on("open.zf.reveal", "#data_picker-modal", function () {
-    let xhr = null;
+  $(document).on(
+    "open.zf.reveal", "#data_picker-modal",
 
-    $("#data_picker-autocomplete").autoComplete({
-      minChars: 2,
-      source: function(term, response) {
-        try {
-          xhr.abort();
-        } catch (exception) { xhr = null; }
+    /* @this HTMLElement */
+    function () {
+      let xhr = null;
 
-        let url = $("#proposal-picker-choose").attr("href");
-        xhr = $.getJSON(
-          url,
-          { term: term },
-          function(data) { response(data); }
-        );
-      },
-      renderItem: function (item, search) {
-        let sanitizedSearch = search.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
-        let re = new RegExp(`(${sanitizedSearch.split(" ").join("|")})`, "gi");
-        let title = item[0];
-        let modelId = item[1];
-        return `<div class="autocomplete-suggestion" data-model-id="${modelId}" data-val ="${title}">${title.replace(re, "<b>$1</b>")}</div>`;
-      },
-      onSelect: function(event, term, item) {
-        let choose = $("#proposal-picker-choose");
-        let modelId = item.data("modelId");
-        let val = item.data("val");
-        choose.data("picker-value", modelId);
-        choose.data("picker-text", val);
-        choose.data("picker-choose", "");
-      }
-    });
-  });
+      $("#data_picker-autocomplete").autoComplete({
+        minChars: 2,
+        source: function(term, response) {
+          try {
+            xhr.abort();
+          } catch (exception) { xhr = null; }
+
+          let url = $("#proposal-picker-choose").attr("href");
+          xhr = $.getJSON(
+            url,
+            { term: term },
+            function(data) { response(data); }
+          );
+        },
+        renderItem: function (item, search) {
+          let sanitizedSearch = search.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+          let re = new RegExp(`(${sanitizedSearch.split(" ").join("|")})`, "gi");
+          let title = item[0];
+          let modelId = item[1];
+          return `<div class="autocomplete-suggestion" data-model-id="${modelId}" data-val ="${title}">${title.replace(re, "<b>$1</b>")}</div>`;
+        },
+        onSelect: function(event, term, item) {
+          let choose = $("#proposal-picker-choose");
+          let modelId = item.data("modelId");
+          let val = item.data("val");
+          choose.data("picker-value", modelId);
+          choose.data("picker-text", val);
+          choose.data("picker-choose", "");
+        }
+      });
+
+      // Remove all the empty values after the selection is made to prevent
+      // these empty values appearing in the list.
+      // This is needed until the following is merged to the core:
+      // https://github.com/decidim/decidim/pull/4842
+      const $choose = $("#proposal-picker-choose", this);
+      $choose.on("click", function() {
+        const $values = $("#plan_proposals .picker-values");
+        $("input[type='checkbox']", $values).each(function(_ev, input) {
+          const $input = $(input);
+          if ($input.val().length < 1) {
+            $input.parent().remove();
+          }
+        });
+      });
+    }
+  );
 });

data/app/commands/decidim/plans/close_plan.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A command with all the business logic when a user closes a plan.
+    class ClosePlan < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # plan         - The plan to publish.
+      # current_user - The current user.
+      def initialize(plan, current_user)
+        @plan = plan
+        @current_user = current_user
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid and the plan is published.
+      # - :invalid if the plan's author is not the current user.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if @current_user.nil?
+
+        close_plan
+
+        broadcast(:ok, @plan)
+      end
+
+      private
+
+      def close_plan
+        Decidim.traceability.perform_action!(
+          "close",
+          @plan,
+          @current_user,
+          visibility: "public-only"
+        ) do
+          @plan.update closed_at: Time.current
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/plans/reopen_plan.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A command with all the business logic when a user reopens a plan.
+    class ReopenPlan < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # plan         - The plan to publish.
+      # current_user - The current user.
+      def initialize(plan, current_user)
+        @plan = plan
+        @current_user = current_user
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid and the plan is published.
+      # - :invalid if the plan's author is not the current user.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if @current_user.nil?
+
+        close_plan
+
+        broadcast(:ok, @plan)
+      end
+
+      private
+
+      def close_plan
+        Decidim.traceability.perform_action!(
+          "reopen",
+          @plan,
+          @current_user,
+          visibility: "public-only"
+        ) do
+          @plan.update closed_at: nil
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/plans/admin/plans_controller.rb

@@ -57,6 +57,38 @@ module Decidim
           end
         end
 
+        def close
+          enforce_permission_to :close, :plan, plan: plan
+
+          ClosePlan.call(plan, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("close.success", scope: "decidim.plans.plans.plan")
+              redirect_to plans_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = t("close.error", scope: "decidim.plans.plans.plan")
+              redirect_to plans_path
+            end
+          end
+        end
+
+        def reopen
+          enforce_permission_to :close, :plan, plan: plan
+
+          ReopenPlan.call(plan, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("reopen.success", scope: "decidim.plans.plans.plan")
+              redirect_to plans_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = t("reopen.error", scope: "decidim.plans.plans.plan")
+              redirect_to plans_path
+            end
+          end
+        end
+
         private
 
         def query

data/app/controllers/decidim/plans/admin/sections_controller.rb

@@ -16,11 +16,6 @@ module Decidim
           @form = form(Admin::PlanSectionsForm).from_model(sections)
         end
 
-        def new
-          enforce_permission_to :create, :sections
-          # TODO
-        end
-
         def create
           enforce_permission_to :create, :section
           @form = form(Admin::PlanSectionsForm).from_params(params)
@@ -33,7 +28,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("update.invalid", scope: i18n_flashes_scope)
-              render template: "index"
+              render action: :index
             end
           end
         end

data/app/controllers/decidim/plans/plan_collaborator_requests_controller.rb

@@ -8,6 +8,8 @@ module Decidim
       before_action :retrieve_plan, only: [:request_access, :request_accept, :request_reject]
 
       def request_access
+        enforce_permission_to :request_access, :plan, plan: @plan
+
         @request_access_form = form(RequestAccessToPlanForm).from_params(params)
         RequestAccessToPlan.call(@request_access_form, current_user) do
           on(:ok) do |_plan|
@@ -22,6 +24,8 @@ module Decidim
       end
 
       def request_accept
+        enforce_permission_to :edit, :plan, plan: @plan
+
         @accept_request_form = form(AcceptAccessToPlanForm).from_params(params)
         AcceptAccessToPlan.call(@accept_request_form, current_user) do
           on(:ok) do |requester_user|
@@ -36,6 +40,8 @@ module Decidim
       end
 
       def request_reject
+        enforce_permission_to :edit, :plan, plan: @plan
+
         @reject_request_form = form(RejectAccessToPlanForm).from_params(params)
         RejectAccessToPlan.call(@reject_request_form, current_user) do
           on(:ok) do |requester_user|

data/app/controllers/decidim/plans/plans_controller.rb

@@ -17,9 +17,9 @@ module Decidim
 
       helper_method :attached_proposals_picker_field
 
-      before_action :authenticate_user!, only: [:new, :create, :edit, :update, :withdraw, :preview, :publish, :destroy]
+      before_action :authenticate_user!, only: [:new, :create, :edit, :update, :withdraw, :preview, :publish, :close, :reopen, :destroy]
       before_action :check_draft, only: [:new]
-      before_action :retrieve_plan, only: [:show, :edit, :update, :withdraw, :preview, :publish, :destroy]
+      before_action :retrieve_plan, only: [:show, :edit, :update, :withdraw, :preview, :publish, :close, :reopen, :destroy]
       before_action :ensure_published!, only: [:show, :withdraw]
 
       def index
@@ -129,6 +129,8 @@ module Decidim
       def preview; end
 
       def publish
+        enforce_permission_to :publish, :plan, plan: @plan
+
         PublishPlan.call(@plan, current_user) do
           on(:ok) do |plan|
             flash[:notice] = I18n.t("publish.success", scope: "decidim.plans.plans.plan")
@@ -142,6 +144,38 @@ module Decidim
         end
       end
 
+      def close
+        enforce_permission_to :close, :plan, plan: @plan
+
+        ClosePlan.call(@plan, current_user) do
+          on(:ok) do |plan|
+            flash[:notice] = I18n.t("close.success", scope: "decidim.plans.plans.plan")
+            redirect_to Decidim::ResourceLocatorPresenter.new(plan).path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = t("close.error", scope: "decidim.plans.plans.plan")
+            redirect_to Decidim::ResourceLocatorPresenter.new(@plan).path
+          end
+        end
+      end
+
+      def reopen
+        enforce_permission_to :close, :plan, plan: @plan
+
+        ReopenPlan.call(@plan, current_user) do
+          on(:ok) do |plan|
+            flash[:notice] = I18n.t("reopen.success", scope: "decidim.plans.plans.plan")
+            redirect_to Decidim::ResourceLocatorPresenter.new(plan).path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = t("reopen.error", scope: "decidim.plans.plans.plan")
+            redirect_to Decidim::ResourceLocatorPresenter.new(@plan).path
+          end
+        end
+      end
+
       private
 
       def check_draft
@@ -149,12 +183,14 @@ module Decidim
       end
 
       def plan_draft
-        Plan.drafts.from_all_author_identities(current_user).not_hidden.where(component: current_component)
+        @plan_draft ||= Plan.drafts.from_all_author_identities(current_user).not_hidden.find_by(component: current_component)
       end
 
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def retrieve_plan
-        @plan = Plan.where(component: current_component).find(params[:id])
+        @plan ||= Plan.where(component: current_component).find(params[:id])
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       def ensure_published!
         return unless @plan

data/app/controllers/decidim/plans/versions_controller.rb

@@ -21,6 +21,8 @@ module Decidim
       end
 
       def item_versions
+        return [] if current_version.transaction_id.nil?
+
         # There may be multiple updates on the item during the same transaction
         Decidim::Plans::PaperTrail::Version.where(
           transaction_id: current_version.transaction_id,
@@ -29,6 +31,8 @@ module Decidim
       end
 
       def associated_versions
+        return [] if current_version.transaction_id.nil?
+
         @associated_versions ||= Decidim::Plans::PaperTrail::Version.where(
           transaction_id: current_version.transaction_id
         ).where.not(
@@ -37,6 +41,8 @@ module Decidim
       end
 
       def content_versions
+        return [] if current_version.transaction_id.nil?
+
         @content_versions ||= item.sections.map do |section|
           content = item.contents.find_by(section: section)
           next unless content

data/app/helpers/decidim/plans/attached_proposals_helper.rb

@@ -35,6 +35,8 @@ module Decidim
                     .try(:resource_scope, current_component)
                     &.order(title: :asc)
                     &.where("title ilike ?", "%#{params[:term]}%")
+                    &.where&.not(state: "rejected")
+                    &.where&.not(published_at: nil)
             render json: query.all.collect { |p| [present(p).title, p.id] }
           end
         end

data/app/helpers/decidim/plans/traceability_helper.rb

@@ -32,21 +32,17 @@ module Decidim
       private
 
       def renderer_for(version)
+        return nil if version.item.nil?
+
         locale = current_locale unless component_settings.multilingual_answers?
 
-        renderer_klass =
-          case version.item.class.name
-          when "Decidim::Plans::Plan"
-            Decidim::Plans::DiffRenderer::Plan
-          when "Decidim::Plans::Content"
-            Decidim::Plans::DiffRenderer::Content
-          when "Decidim::Categorization"
-            Decidim::Plans::DiffRenderer::Categorization
-          when "Decidim::Component"
-            Decidim::Plans::DiffRenderer::Component
-          end
+        item_klass = version.item.class.name
+        lastpart = item_klass.split("::").last
+        renderer_klass = "Decidim::Plans::DiffRenderer::#{lastpart}"
+
+        return nil unless defined?(renderer_klass)
 
-        renderer_klass.new(version, locale)
+        renderer_klass.constantize.new(version, locale)
       end
 
       # Renders the given value in a user-friendly way based on the value class.

data/app/models/decidim/plans/plan.rb

@@ -99,6 +99,13 @@ module Decidim
         published_at.present?
       end
 
+      # Public: Checks if the plan has been closed or not.
+      #
+      # Returns Boolean.
+      def closed?
+        closed_at.present?
+      end
+
       # Public: Checks if the organization has given an answer for the plan.
       #
       # Returns Boolean.
@@ -191,6 +198,14 @@ module Decidim
         Arel.sql(query)
       end
 
+      def self.export_serializer
+        Decidim::Plans::PlanSerializer
+      end
+
+      def self.data_portability_images(user)
+        user_collection(user).map { |p| p.attachments.collect(&:file) }
+      end
+
       # Checks whether the plan is inside the time window to be editable or not once published.
       def within_edit_time_limit?
         true

data/app/permissions/decidim/plans/admin/permissions.rb

@@ -23,6 +23,8 @@ module Decidim
             permission_action.allow!
           when :edit, :update, :destroy
             permission_action.allow! if plan.present? || section.present?
+          when :close
+            permission_action.allow! if plan.present?
           end
 
           permission_action

data/app/permissions/decidim/plans/permissions.rb

@@ -35,6 +35,8 @@ module Decidim
           can_withdraw_plan?
         when :publish
           can_publish_plan?
+        when :close
+          can_close_plan?
         when :request_access
           can_request_access_plan?
         end
@@ -45,7 +47,7 @@ module Decidim
       end
 
       def can_edit_plan?
-        toggle_allow(plan.open? && plan.editable_by?(user))
+        toggle_allow(plan.open? && !plan.closed? && plan.editable_by?(user))
       end
 
       def can_withdraw_plan?
@@ -56,6 +58,10 @@ module Decidim
         toggle_allow(plan.open? && plan.editable_by?(user))
       end
 
+      def can_close_plan?
+        toggle_allow(plan && plan.created_by?(user))
+      end
+
       def can_request_access_plan?
         return toggle_allow(false) unless plan.open?
         return toggle_allow(false) if plan.editable_by?(user)

data/app/services/decidim/plans/diff_renderer/base.rb

@@ -82,7 +82,7 @@ module Decidim
           )
         end
 
-        def parse_i18n_changeset(attribute, values, type, diff)
+        def parse_i18n_changeset(attribute, values, _type, diff)
           values.last.each_key do |locale, _value|
             next if display_locale && display_locale != locale
 

data/app/views/decidim/plans/admin/plans/_bulk-actions.html.erb

@@ -5,5 +5,7 @@
     <% if allowed_to? :create, :plan %>
       <%= link_to t("actions.new", scope: "decidim.plans"), new_plan_path, class: "button tiny button--simple" %>
     <% end %>
+
+    <%= export_dropdown %>
   </div>
 </div>

data/app/views/decidim/plans/admin/plans/_plan-tr.html.erb

@@ -40,6 +40,14 @@
       <%= icon_link_to "pencil", edit_plan_path(plan), t("actions.edit_plan", scope: "decidim.plans"), class: "action-icon--edit-plan" %>
     <% end %>
 
+    <% if allowed_to? :close, :plan, plan: plan %>
+      <% if plan.closed? %>
+        <%= icon_link_to "action-undo", reopen_plan_path(plan), t("actions.reopen_plan", scope: "decidim.plans"), method: :post, class: "action-icon--reopen-plan" %>
+      <% else %>
+        <%= icon_link_to "ban", close_plan_path(plan), t("actions.close_plan", scope: "decidim.plans"), method: :post, class: "action-icon--close-plan" %>
+      <% end %>
+    <% end %>
+
     <% if allowed_to? :create, :plan_answer %>
       <%= icon_link_to "comment-square", edit_plan_plan_answer_path(plan_id: plan.id, id: plan.id), t("actions.answer", scope: "decidim.plans"), class: " icon--small" %>
     <% else %>

data/app/views/decidim/plans/plans/show.html.erb

@@ -45,6 +45,13 @@
         <% if allowed_to?(:edit, :plan, plan: @plan) %>
           <%= link_to t("edit", scope:"decidim.plans.plans.show"), edit_plan_path(@plan), class: "button secondary hollow expanded button--sc mt-s", id: "plan_edit" %>
         <% end %>
+        <% if allowed_to?(:close, :plan, plan: @plan) %>
+          <% if @plan.closed? %>
+            <%= link_to t("reopen", scope:"decidim.plans.plans.show"), reopen_plan_path(@plan), method: :post, class: "button secondary hollow expanded button--sc mt-s", id: "plan_reopen", data: { confirm: t("reopen_confirm", scope:"decidim.plans.plans.show") } %>
+          <% else %>
+            <%= link_to t("close", scope:"decidim.plans.plans.show"), close_plan_path(@plan), method: :post, class: "button secondary hollow expanded button--sc mt-s", id: "plan_close", data: { confirm: t("close_confirm", scope:"decidim.plans.plans.show") } %>
+          <% end %>
+        <% end %>
 
         <%= render "request_access_form" %>
 

data/config/locales/en.yml

@@ -1,11 +1,15 @@
 ---
 en:
+  activerecord:
+    models:
+      decidim/plans/plan: Plan
   activemodel:
     attributes:
       plan:
         proposals: Proposals
         category_id: Category
         decidim_category_id: Category
+        decidim_component_id: Component
         decidim_scope_id: Scope
         state: State
         title: Title
@@ -39,19 +43,27 @@ en:
             comments_blocked: Comments blocked
             creation_enabled: Creation enabled
             plan_answering_enabled: Answering enabled
+    pages:
+      home:
+        statistics:
+          plans_count: Plans
     participatory_processes:
       statistics:
         plans_count: Plans
     plans:
       actions:
         answer: Answer
+        close_plan: Mark as done
         edit_plan: Edit
         new: Submit new plan
+        reopen_plan: Open for editing
         sections: Sections
         title: Actions
       admin:
         actions:
           preview: Preview
+        exports:
+          plans: Plans
         plan_answers:
           edit:
             accepted: Accepted
@@ -207,15 +219,24 @@ en:
           random: Random
           recent: Recent
         plan:
+          close:
+            error: Error marking the item as done.
+            success: Item marked done successfully.
           publish:
             error: Error publishing new content.
             success: Published successfully.
+          reopen:
+            error: Error opening item for editing.
+            success: Item opened for editing successfully.
           view_plan: View plan
           withdraw:
             error: Error withdrawing.
             success: Withdrawn successfully.
         show:
           back: Back
+          close: Mark as done
+          close_confirm: Are you sure you want to mark this item done? After
+            marking done, the item can no longer be edited.
           edit: Edit
           hidden_authors_count:
             one: and %{count} more person
@@ -229,6 +250,8 @@ en:
           publish: Publish
           publish_info: Publish this version of the draft or
           published_proposal: published plan
+          reopen: Open for editing
+          reopen_confirm: Are you sure you want to open this item for editing?
           report: Report
           request_access: Request editing permissions
           requested_access: Editing permissions requested

data/config/locales/fi.yml

@@ -1,11 +1,15 @@
 ---
 fi:
+  activerecord:
+    models:
+      decidim/plans/plan: Suunnitelma
   activemodel:
     attributes:
       plan:
         proposals: Ehdotukset
         category_id: Kategoria
         decidim_category_id: Kategoria
+        decidim_component_id: Komponentti
         decidim_scope_id: Teema
         state: Tila
         title: Otsikko
@@ -39,19 +43,27 @@ fi:
             comments_blocked: Kommentointi estetty
             creation_enabled: Luonti sallittu
             plan_answering_enabled: Vastaaminen sallittu
+    pages:
+      home:
+        statistics:
+          plans_count: Suunnitelmia
     participatory_processes:
       statistics:
         plans_count: Suunnitelmaa
     plans:
       actions:
         answer: Vastaa
+        close_plan: Merkitse valmiiksi
         edit_plan: Muokkaa
         new: Tee uusi suunnitelma
+        reopen_plan: Avaa muokattavaksi
         sections: Osiot
         title: Toiminnot
       admin:
         actions:
           preview: Esikatsele
+        exports:
+          plans: Suunnitelmat
         plan_answers:
           edit:
             accepted: Hyväksytty
@@ -207,15 +219,24 @@ fi:
           random: Satunnainen
           recent: Uusimmat
         plan:
+          close:
+            error: Valmiiksi merkitseminen epäonnistui.
+            success: Valmiiksi merkitseminen onnistui.
           publish:
             error: Uuden sisällön julkaiseminen epäonnistui.
             success: Julkaisu onnistui.
+          reopen:
+            error: Muokattavaksi avaaminen epäonnistui.
+            success: Muokattavaksi avaaminen onnistui.
           view_plan: Näytä suunnitelma
           withdraw:
             error: Peruuttaminen epäonnistui.
             success: Peruuttaminen onnistui.
         show:
           back: Takaisin
+          close: Merkitse valmiiksi
+          close_confirm: Haluatko varmasti merkitä tämän kohteen valmiiksi? Kun
+            kohde on merkitty valmiiksi, sitä ei voi enää muokata.
           edit: Muokkaa
           hidden_authors_count:
             one: ja %{count} muu henkilö
@@ -229,6 +250,8 @@ fi:
           publish: Julkaise
           publish_info: Julkaise tämä luonnosversio tai
           published_proposal: julkaistu suunnitelma
+          reopen: Avaa muokattavaksi
+          reopen_confirm: Haluatko varmasti avata tämän kohteen muokattavaksi?
           report: Ilmoita
           request_access: Pyydä muokkausoikeudet
           requested_access: Muokkausoikeudet pyydetty

data/config/locales/sv.yml

@@ -1,11 +1,16 @@
 ---
 sv:
+  activerecord:
+    models:
+      decidim/plans/plan: Plan
   activemodel:
     attributes:
       plan:
         proposals: Proposals
         category_id: Category
         decidim_category_id: Category
+        decidim_component_id: Component
+        decidim_proposal_id: Proposal
         decidim_scope_id: Scope
         state: State
         title: Title
@@ -39,19 +44,27 @@ sv:
             comments_blocked: Comments blocked
             creation_enabled: Creation enabled
             plan_answering_enabled: Answering enabled
+    pages:
+      home:
+        statistics:
+          plans_count: Plans
     participatory_processes:
       statistics:
         plans_count: Plans
     plans:
       actions:
         answer: Answer
+        close_plan: Mark as done
         edit_plan: Edit
         new: Submit new plan
+        reopen_plan: Open for editing
         sections: Sections
         title: Actions
       admin:
         actions:
           preview: Preview
+        exports:
+          plans: Plans
         plan_answers:
           edit:
             accepted: Accepted
@@ -207,15 +220,24 @@ sv:
           random: Random
           recent: Recent
         plan:
+          close:
+            error: Error marking the item as done.
+            success: Item marked done successfully.
           publish:
             error: Error publishing new content.
             success: Published successfully.
+          reopen:
+            error: Error opening item for editing.
+            success: Item opened for editing successfully.
           view_plan: View plan
           withdraw:
             error: Error withdrawing.
             success: Withdrawn successfully.
         show:
           back: Back
+          close: Mark as done
+          close_confirm: Are you sure you want to mark this item done? After
+            marking done, the item can no longer be edited.
           edit: Edit
           hidden_authors_count:
             one: and %{count} more person
@@ -229,6 +251,8 @@ sv:
           publish: Publish
           publish_info: Publish this version of the draft or
           published_proposal: published plan
+          reopen: Open for editing
+          reopen_confirm: Are you sure you want to open this item for editing?
           report: Report
           request_access: Request editing permissions
           requested_access: Editing permissions requested

data/db/migrate/20190214124014_add_closed_at_to_decidim_plans.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddClosedAtToDecidimPlans < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_plans_plans, :closed_at, :datetime
+    add_index :decidim_plans_plans, :closed_at
+  end
+end

data/lib/decidim/plans/admin_engine.rb

@@ -13,6 +13,10 @@ module Decidim
         resources :plans, only: [:index, :new, :create, :edit, :update] do
           get :search_proposals
           resources :plan_answers, only: [:edit, :update]
+          member do
+            post :close
+            post :reopen
+          end
         end
         resources :sections, only: [:index, :new, :create, :edit, :update]
 

data/lib/decidim/plans/component.rb

@@ -13,7 +13,7 @@ Decidim.register_component(:plans) do |component|
 
   component.data_portable_entities = ["Decidim::Plans::Plan"]
 
-  component.actions = %w(create withdraw)
+  component.actions = %w(create withdraw close reopen)
 
   component.permissions_class_name = "Decidim::Plans::Permissions"
 
@@ -23,7 +23,7 @@ Decidim.register_component(:plans) do |component|
     settings.attribute :comments_enabled, type: :boolean, default: true
     settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :attachments_allowed, type: :boolean, default: false
-    settings.attribute :multilingual_answers, type: :boolean, default: true
+    settings.attribute :multilingual_answers, type: :boolean
   end
 
   component.settings(:step) do |settings|
@@ -51,6 +51,19 @@ Decidim.register_component(:plans) do |component|
     Decidim::Comments::Comment.where(root_commentable: plans).count
   end
 
+  component.exports :plans do |exports|
+    exports.collection do |component_instance|
+      Decidim::Plans::Plan
+        .published
+        .where(component: component_instance)
+        .includes(:category, component: { participatory_space: :organization })
+    end
+
+    exports.include_in_open_data = true
+
+    exports.serializer Decidim::Plans::PlanSerializer
+  end
+
   component.seeds do |participatory_space|
     admin_user = Decidim::User.find_by(
       organization: participatory_space.organization,
@@ -69,7 +82,7 @@ Decidim.register_component(:plans) do |component|
       published_at: Time.current,
       participatory_space: participatory_space,
       settings: {
-        multilingual_answers: true
+        multilingual_answers: false
       },
       step_settings: step_settings
     }

data/lib/decidim/plans/engine.rb

@@ -13,6 +13,8 @@ module Decidim
           member do
             get :preview
             post :publish
+            post :close
+            post :reopen
             put :withdraw
             post :request_access, controller: "plan_collaborator_requests"
             post :request_accept, controller: "plan_collaborator_requests"

data/lib/decidim/plans/plan_serializer.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # This class serializes a Proposal so can be exported to CSV, JSON or other
+    # formats.
+    class PlanSerializer < Decidim::Exporters::Serializer
+      include Decidim::ApplicationHelper
+      include Decidim::ResourceHelper
+
+      # Public: Initializes the serializer with a plan.
+      def initialize(plan)
+        @plan = plan
+      end
+
+      # Public: Exports a hash with the serialized data for this proposal.
+      def serialize
+        values = {
+          id: plan.id,
+          category: {
+            id: plan.category.try(:id),
+            name: plan.category.try(:name)
+          },
+          scope: {
+            id: plan.scope.try(:id),
+            name: plan.scope.try(:name)
+          },
+          participatory_space: {
+            id: plan.participatory_space.id,
+            url: Decidim::ResourceLocatorPresenter.new(plan.participatory_space).url
+          },
+          component: { id: component.id },
+          state: plan.state.to_s,
+          comments: plan.comments.count,
+          attachments: plan.attachments.count,
+          followers: plan.followers.count,
+          published_at: plan.published_at,
+          closed_at: plan.closed_at,
+          url: url,
+          related_proposals: {
+            ids: related_proposal_ids,
+            urls: related_proposal_urls
+          },
+          title: plan.title
+        }
+
+        # Add section content
+        plan.sections.each do |sect|
+          content = plan.contents.find_by(section: sect)
+          values["section_#{sect.id}".to_sym] = {
+            title: sect.body,
+            value: content.try(:body)
+          }
+        end
+
+        values
+      end
+
+      private
+
+      attr_reader :plan
+
+      def component
+        plan.component
+      end
+
+      def related_proposal_ids
+        plan.proposals.map(&:id)
+      end
+
+      def related_proposal_urls
+        plan.proposals.map do |proposal|
+          Decidim::ResourceLocatorPresenter.new(proposal).url
+        end
+      end
+
+      def url
+        Decidim::ResourceLocatorPresenter.new(plan).url
+      end
+    end
+  end
+end

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

@@ -41,10 +41,10 @@ FactoryBot.define do
       end
     end
 
-    trait :with_single_language_answers do
+    trait :with_multilingual_answers do
       settings do
         {
-          multilingual_answers: false
+          multilingual_answers: true
         }
       end
     end
@@ -89,6 +89,13 @@ FactoryBot.define do
       published_at { nil }
     end
 
+    trait :official do
+      after :build do |plan|
+        plan.coauthorships.clear
+        plan.coauthorships.build(author: plan.organization)
+      end
+    end
+
     trait :evaluating do
       state { "evaluating" }
       answered_at { Time.current }

data/lib/decidim/plans/version.rb

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

data/lib/decidim/plans.rb

@@ -6,11 +6,13 @@ require_relative "plans/engine"
 require_relative "plans/admin_engine"
 require_relative "plans/paper_trail"
 require_relative "plans/component"
-require_relative "plans/locale_aware"
-require_relative "plans/optionally_translatable_attributes"
 
 module Decidim
   module Plans
+    autoload :LocaleAware, "decidim/plans/locale_aware"
+    autoload :OptionallyTranslatableAttributes, "decidim/plans/optionally_translatable_attributes"
+    autoload :PlanSerializer, "decidim/plans/plan_serializer"
+
     # Public: Stores an instance of Loggability
     def self.loggability
       @loggability ||= Loggability.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-plans
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Antti Hukkanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -151,11 +151,13 @@ files:
 - app/commands/decidim/plans/admin/update_plan.rb
 - app/commands/decidim/plans/admin/update_sections.rb
 - app/commands/decidim/plans/attachment_methods.rb
+- app/commands/decidim/plans/close_plan.rb
 - app/commands/decidim/plans/create_plan.rb
 - app/commands/decidim/plans/destroy_plan.rb
 - app/commands/decidim/plans/nested_updater.rb
 - app/commands/decidim/plans/publish_plan.rb
 - app/commands/decidim/plans/reject_access_to_plan.rb
+- app/commands/decidim/plans/reopen_plan.rb
 - app/commands/decidim/plans/request_access_to_plan.rb
 - app/commands/decidim/plans/respond_to_access_request.rb
 - app/commands/decidim/plans/update_plan.rb
@@ -286,6 +288,7 @@ files:
 - db/migrate/20190202123044_create_version_associations.rb
 - db/migrate/20190202123045_add_transaction_id_column_to_versions.rb
 - db/migrate/20190202200716_add_update_token_to_decidim_plans.rb
+- db/migrate/20190214124014_add_closed_at_to_decidim_plans.rb
 - lib/decidim/plans.rb
 - lib/decidim/plans/admin.rb
 - lib/decidim/plans/admin_engine.rb
@@ -295,6 +298,7 @@ files:
 - lib/decidim/plans/optionally_translatable_attributes.rb
 - lib/decidim/plans/paper_trail.rb
 - lib/decidim/plans/paper_trail/record_trail.rb
+- lib/decidim/plans/plan_serializer.rb
 - lib/decidim/plans/test/factories.rb
 - lib/decidim/plans/version.rb
 homepage: https://github.com/mainio/decidim-module-plans