decidim-plans 0.16.6 → 0.16.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870133d81fb0fd7608a2087fbf2fdb7a434a37ebe3437334c9cdb604c2afd3f8
-  data.tar.gz: 4e28e6926fbdfe8339eb19ef66c1c455cef50ad9cf42a1940f2c2ec9df0a041f
+  metadata.gz: 210bbe22dc50de4ec472503edc4ec7cc7944ccf4623cbd0602ba2f56ac73c59c
+  data.tar.gz: 4b6ba7db25df3fc75fcd770511918ad71aeb38247769f0df384b2090f7d7d389
 SHA512:
-  metadata.gz: 1cd3865a386f58d321ff9e077e7c8728b011dfe85cffcc52b0c6854759ee91592398eab98506fdb31d162f52022a532a0bc5e18d21191e88798d9fa29fc84858
-  data.tar.gz: 55e53122d62b560a70532c9ce0d3b2b8466b4ca2187cc54664df4f3710a8697b8f5112c200d597d39e19006271ae4402d6421d5a8dac83e8b5dd254201bfb56f
+  metadata.gz: a2c04c5480bad9093b12345eedb2ae702867fa770b3a76eb7b548349620492db1997091c453424f1e5b01f7640a7a404e13cb80d4d1790921bafce4faa4fd79e
+  data.tar.gz: 374f57e0e4ce29c5ea888c631b3b6623251a24dbd58890292977d9f9dec60ff7631fb5ea57d781ec4e95b7a30ee20f59481e944826234b571d95a5c8bd2a2147

data/README.md

@@ -59,7 +59,8 @@ can start writing the plans when plan creation is enabled.
 
 ## Contributing
 
-For instructions how to setup your development environment for Decidim, see [Decidim](https://github.com/decidim/decidim). Also follow Decidim's general
+For instructions how to setup your development environment for Decidim, see
+[Decidim](https://github.com/decidim/decidim). Also follow Decidim's general
 instructions for development for this project as well.
 
 ### Developing

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

@@ -1,3 +1,95 @@
 $(() => {
-  // Add the needed JS initialization code here
+  const $search = $("#data_picker-autocomplete");
+  const $results = $("#plan-tags-results");
+  const $template = $(".decidim-template", $results);
+  const $form = $search.parents("form");
+  const addRowItem = function(id, title) {
+    let template = $template.html();
+    template = template.replace(new RegExp("{{tag_id}}", "g"), id);
+    template = template.replace(new RegExp("{{tag_name}}", "g"), title);
+    const $newRow = $(template);
+    $("table tbody", $results).append($newRow);
+    $results.removeClass("hide");
+
+    // Add it to the autocomplete form
+    const $field = $(`<input type="hidden" name="tags[]" value="${id}">`);
+    $form.append($field);
+
+    // Listen to the click event on the remove button
+    $(".remove-tagging", $newRow).on("click", function(ev) {
+      ev.preventDefault();
+      $newRow.remove();
+      $field.remove();
+
+      if ($("table tbody tr", $results).length < 1) {
+        $results.addClass("hide");
+      }
+    });
+  };
+  let xhr = null;
+  let currentSearch = "";
+
+  $search.on("keyup", function() {
+    currentSearch = $search.val();
+  });
+
+  $search.autoComplete({
+    minChars: 2,
+    cache: 0,
+    source: function(term, response) {
+      try {
+        xhr.abort();
+      } catch (exception) { xhr = null; }
+
+      const url = $form.attr("action");
+      xhr = $.getJSON(
+        url,
+        $form.serializeArray(),
+        function(data) {
+          if (data.length > 0) {
+            response(data);
+          } else {
+            response([
+              [null, $search.data("no-results-text"), term]
+            ]);
+          }
+        }
+      );
+    },
+    renderItem: function (item, search) {
+      const sanitizedSearch = search.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+      const re = new RegExp(`(${sanitizedSearch.split(" ").join("|")})`, "gi");
+      const modelId = item[0];
+      const title = item[1];
+      const val = `${title}`;
+
+      if (modelId === null) {
+        // Empty result
+        const term = item[2];
+        const url = $search.data("no-results-url").replace("{{term}}", encodeURIComponent(term));
+        return `<div><a href="${url}">${val.replace("{{term}}", term)}</a></div>`;
+      }
+      return `<div class="autocomplete-suggestion" data-model-id="${modelId}" data-val="${title}">${val.replace(re, "<b>$1</b>")}</div>`;
+    },
+    onSelect: function(event, term, item) {
+      const $suggestions = $search.data("sc");
+      const modelId = item.data("modelId");
+      const title = item.data("val");
+
+      addRowItem(modelId, title);
+
+      $search.val(currentSearch);
+      setTimeout(function() {
+        $(`[data-model-id="${modelId}"]`, $suggestions).remove();
+        $suggestions.show();
+      }, 20);
+    }
+  });
+
+  const resultsArray = $results.data("results");
+  if (Array.isArray(resultsArray)) {
+    resultsArray.forEach((value) => {
+      addRowItem(value[0], value[1]);
+    });
+  }
 });

data/app/assets/javascripts/decidim/plans/multifield/dynamic_fields.component.js.es6

@@ -0,0 +1,39 @@
+/**
+ * Extends / overrides:
+ * decidim/admin/dynamic_fields.component
+ *
+ * Fixes broken attachments in IE11 by overriding the `_addField` method in the
+ *`DynamicFieldsComponent` coming from the `decidim-admin` component.
+ *
+ * For further details, see:
+ * https://github.com/mainio/decidim-module-plans/issues/13
+**/
+
+((exports) => {
+  const { DynamicFieldsComponent } = exports.DecidimAdmin;
+
+  class DynamicFieldsComponentExtended extends DynamicFieldsComponent {
+    _addField() {
+      const $container = $(this.wrapperSelector).find(this.containerSelector);
+      // START OVERRIDE
+      const $template = $(this.wrapperSelector).children(".decidim-template");
+      // END OVERRIDE
+      const $newField = $($template.html()).template(this.placeholderId, this._getUID());
+
+      $newField.find("ul.tabs").attr("data-tabs", true);
+
+      $newField.appendTo($container);
+      $newField.foundation();
+
+      if (this.onAddField) {
+        this.onAddField($newField);
+      }
+    }
+  }
+
+  exports.DecidimAdmin = exports.DecidimAdmin || {};
+  exports.DecidimAdmin.DynamicFieldsComponent = DynamicFieldsComponentExtended;
+  exports.DecidimAdmin.createDynamicFields = (options) => {
+    return new DynamicFieldsComponentExtended(options);
+  };
+})(window);

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

@@ -1,5 +1,6 @@
 // = require decidim/admin/auto_buttons_by_position.component
 // = require decidim/admin/auto_label_by_position.component
 // = require decidim/admin/dynamic_fields.component
+// = require decidim/plans/multifield/dynamic_fields.component
 // = require decidim/admin/sort_list.component
 // = require decidim/plans/multifield/component

data/app/cells/decidim/plans/plan_m/tags.erb

@@ -0,0 +1 @@
+<%= render partial: "decidim/plans/shared/tags.html", locals: { resource: model, tags_class_extra: "tags--proposal" } %>

data/app/cells/decidim/plans/plan_m_cell.rb

@@ -31,7 +31,7 @@ module Decidim
       end
 
       def has_badge?
-        answered? || withdrawn?
+        closed? || answered? || withdrawn?
       end
 
       def has_link_to_resource?

data/app/cells/decidim/plans/tags/show.erb

@@ -0,0 +1,7 @@
+<%= content_tag :ul, class: tags_classes do %>
+  <%= cell("decidim/plans/tags", model).category %>
+
+  <%= cell("decidim/plans/tags", model).scope %>
+
+  <%= cell("decidim/plans/tags", model).taggings %>
+<% end %>

data/app/cells/decidim/plans/tags/taggings.erb

@@ -0,0 +1,3 @@
+<% model.tags.each do |tag| %>
+  <%= content_tag :li, link_to_tag(tag) %>
+<% end %>

data/app/cells/decidim/plans/tags_cell.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # This cell renders:
+    # - The category of a resource shown with the translated name (parent)
+    # - The scope of a resource shown with the translated name (parent)
+    # - The assigned tags from the plans
+    #
+    # The context `resource` must be present example use inside another `cell`:
+    #   <%= cell("decidim/category", model.category, context: {resource: model}) %>
+    #
+    class TagsCell < Decidim::TagsCell
+      def show
+        render if category? || scope? || taggings?
+      end
+
+      def taggings
+        render if taggings?
+      end
+
+      private
+
+      def category?
+        model.category.present?
+      end
+
+      def scope?
+        has_visible_scopes?(model)
+      end
+
+      def taggings?
+        model.tags.any?
+      end
+
+      def link_to_tag(tag)
+      end
+
+      def link_to_tag(tag)
+        link_to tag_name(tag), tag_path(tag)
+      end
+
+      def tag_name(tag)
+        translated_attribute(tag.name)
+      end
+
+      def tag_path(tag)
+        resource_locator(model).index(filter: { tag_id: [tag.id] })
+      end
+    end
+  end
+end

data/app/commands/decidim/plans/admin/answer_plan.rb

@@ -39,7 +39,10 @@ module Decidim
             plan,
             form.current_user
           ) do
+            closed_at = plan.closed_at || Time.current
+
             plan.update!(
+              closed_at: closed_at,
               state: @form.state,
               answer: @form.answer,
               answered_at: Time.current

data/app/commands/decidim/plans/admin/create_tag.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A command with all the business logic when a user creates a new tag.
+      class CreateTag < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the tag.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_tag
+
+          broadcast(:ok, tag)
+        end
+
+        private
+
+        attr_reader :form, :tag
+
+        def create_tag
+          @tag = Decidim.traceability.create(
+            Tag,
+            form.current_user,
+            name: form.name,
+            organization: form.organization
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/plans/admin/destroy_tag.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A command with all the business logic when a user destroys a tag.
+      class DestroyTag < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # tag - The target object to be destroyed.
+        # current_user - the user performing the action.
+        def initialize(tag, current_user)
+          @tag = tag
+          @current_user = current_user
+        end
+
+        # Destroys the tag if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        #
+        # Returns nothing.
+        def call
+          destroy_tag
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :tag, :current_user
+
+        def destroy_tag
+          Decidim.traceability.perform_action!(
+            :delete,
+            tag,
+            current_user
+          ) do
+            tag.destroy!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/plans/admin/update_plan_taggings.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A command with all the business logic when a user updates a tag.
+      class UpdatePlanTaggings < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # plan - The target object to be updated.
+        def initialize(form, plan)
+          @form = form
+          @plan = plan
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the plan.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_plan_taggings
+
+          broadcast(:ok, plan)
+        end
+
+        private
+
+        attr_reader :form, :plan
+
+        def update_plan_taggings
+          Decidim.traceability.perform_action!(
+            :update,
+            plan,
+            form.current_user
+          ) do
+            plan.taggings.destroy_all
+            plan.update!(
+              tags: Tag.where(
+                id: form.tags,
+                organization: plan.component.organization
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/plans/admin/update_tag.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A command with all the business logic when a user updates a tag.
+      class UpdateTag < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # tag - The target object to be updated.
+        def initialize(form, tag)
+          @form = form
+          @tag = tag
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the plan.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_tag
+
+          broadcast(:ok, tag)
+        end
+
+        private
+
+        attr_reader :form, :tag
+
+        def update_tag
+          Decidim.traceability.perform_action!(
+            :update,
+            tag,
+            form.current_user
+          ) do
+            tag.update!(name: form.name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,15 @@ module Decidim
           @current_user,
           visibility: "public-only"
         ) do
-          @plan.update closed_at: Time.current
+          # Unless the plan has already been answered, change the state to
+          # "evaluating".
+          state = @plan.state
+          state = "evaluating" unless @plan.answered?
+
+          @plan.update!(
+            state: state,
+            closed_at: Time.current
+          )
         end
       end
     end

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

@@ -36,7 +36,15 @@ module Decidim
           @current_user,
           visibility: "public-only"
         ) do
-          @plan.update closed_at: nil
+          # Unless the plan has already been answered, change the state back to
+          # "open".
+          state = @plan.state
+          state = "open" unless @plan.answered?
+
+          @plan.update!(
+            state: state,
+            closed_at: nil
+          )
         end
       end
     end

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

@@ -11,7 +11,7 @@ module Decidim
         helper Plans::ApplicationHelper
         helper Plans::AttachmentsHelper
         helper Plans::RemainingCharactersHelper
-        helper_method :plans, :query, :form_presenter, :attached_proposals_picker_field
+        helper_method :plans, :plan, :query, :counts, :form_presenter, :attached_proposals_picker_field
 
         def new
           enforce_permission_to :create, :plans
@@ -89,16 +89,46 @@ module Decidim
           end
         end
 
+        def taggings
+          enforce_permission_to :edit_taggings, :plan, plan: plan
+
+          @form = form(Admin::TaggingsForm).from_model(plan)
+        end
+
+        def update_taggings
+          enforce_permission_to :edit_taggings, :plan, plan: plan
+
+          @form = form(Admin::TaggingsForm).from_params(params)
+          Admin::UpdatePlanTaggings.call(@form, plan) do
+            on(:ok) do
+              flash[:notice] = I18n.t("plans.update_taggings.success", scope: "decidim.plans.admin")
+              redirect_to plans_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("plans.update_taggings.invalid", scope: "decidim.plans.admin")
+              render :taggings
+            end
+          end
+        end
+
         private
 
         def query
-          @query ||= Plan.where(component: current_component).ransack(params[:q])
+          @query ||= Plan.published.where(component: current_component).ransack(params[:q])
         end
 
         def plans
           @plans ||= query.result.page(params[:page]).per(15)
         end
 
+        def counts
+          @counts ||= {
+            published: Plan.published.where(component: current_component).count,
+            drafts: Plan.drafts.where(component: current_component).count
+          }
+        end
+
         def plan
           @plan ||= Plan.where(component: current_component).find(params[:id])
         end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # This controller allows admins to the tags related to plans.
+      class TagsController < Admin::ApplicationController
+        include TranslatableAttributes
+
+        helper_method :plan, :tags
+
+        def index
+          enforce_permission_to :read, :plan_tag
+
+          respond_to do |format|
+            format.html do
+              render :index
+            end
+            format.json do
+              return render json: [] unless params.has_key?(:term)
+
+              tags = OrganizationTags.new(current_organization).query.where(
+                "name ->> '#{current_locale}' ILIKE ?",
+                "%#{params[:term]}%"
+              ).where.not(
+                id: plan.tags.pluck(:id)
+              )
+              render json: tags.map { |t| [t.id, translated_attribute(t.name)] }
+            end
+          end
+        end
+
+        def new
+          enforce_permission_to :create, :plan_tags
+
+          dummy_tag = Tag.new(organization: current_organization)
+          dummy_tag.name = {}
+          current_organization.available_locales.map do |locale|
+            dummy_tag.name[locale] = params[:name]
+          end
+
+          @form = form(Admin::TagForm).from_model(dummy_tag)
+          @form.back_to_plan = true if params[:back_to_plan].to_i == 1
+        end
+
+        def create
+          enforce_permission_to :create, :plan_tags
+          @form = form(Admin::TagForm).from_params(params)
+
+          Admin::CreateTag.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("create.success", scope: i18n_flashes_scope)
+
+              return redirect_to taggings_plan_path(plan) if @form.back_to_plan
+
+              redirect_to plan_tags_path(plan)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("create.invalid", scope: i18n_flashes_scope)
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :edit, :plan_tags, tag: tag
+          @form = form(Admin::TagForm).from_model(tag)
+        end
+
+        def update
+          enforce_permission_to :edit, :plan_tags, tag: tag
+
+          @form = form(Admin::TagForm).from_params(params)
+          Admin::UpdateTag.call(@form, @tag) do
+            on(:ok) do
+              flash[:notice] = I18n.t("update.success", scope: i18n_flashes_scope)
+              redirect_to plan_tags_path(plan)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("update.invalid", scope: i18n_flashes_scope)
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :plan_tags, tag: tag
+
+          Admin::DestroyTag.call(@tag, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("destroy.success", scope: i18n_flashes_scope)
+              redirect_to plan_tags_path(plan)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("destroy.error", scope: i18n_flashes_scope)
+              redirect_to plan_tags_path(plan)
+            end
+          end
+        end
+
+        private
+
+        def i18n_flashes_scope
+          "decidim.plans.admin.tags"
+        end
+
+        def tag
+          @tag ||= Tag.where(organization: current_organization).find(params[:id])
+        end
+
+        def plan
+          @plan ||= Plan.where(component: current_component).find(params[:plan_id])
+        end
+
+        def tags
+          @tags ||= OrganizationTags.new(
+            current_organization
+          ).query.page(params[:page]).per(30)
+        end
+      end
+    end
+  end
+end