decidim-plans 0.15.0

data/app/forms/decidim/plans/admin/plan_form.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A form object to be used when admin users want to create a plan.
+      class PlanForm < Decidim::Form
+        include OptionallyTranslatableAttributes
+        include Decidim::ApplicationHelper
+        mimic :plan
+
+        optionally_translatable_attribute :title, String
+
+        attribute :category_id, Integer
+        attribute :scope_id, Integer
+        attribute :attachments, Array[Plans::AttachmentForm]
+        attribute :contents, Array[Decidim::Plans::ContentForm]
+        attribute :proposal_ids, Array[Integer]
+
+        optionally_translatable_validate_presence :title
+
+        validates :proposals, presence: true
+        validates :category, presence: true, if: ->(form) { form.category_id.present? }
+        validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+
+        validate :scope_belongs_to_participatory_space_scope
+
+        delegate :categories, to: :current_component
+
+        def map_model(model)
+          self.contents = model.sections.map do |section|
+            ContentForm.from_model(
+              Content
+                .where(plan: model, section: section)
+                .first_or_initialize(plan: model, section: section)
+            )
+          end
+
+          return unless model.categorization
+
+          self.category_id = model.categorization.decidim_category_id
+          self.scope_id = model.decidim_scope_id
+        end
+
+        alias component current_component
+
+        # Finds the Category from the category_id.
+        #
+        # Returns a Decidim::Category
+        def category
+          @category ||= categories.find_by(id: category_id)
+        end
+
+        # Finds the Scope from the given decidim_scope_id, uses participatory space scope if missing.
+        #
+        # Returns a Decidim::Scope
+        def scope
+          @scope ||= @scope_id ? current_participatory_space.scopes.find_by(id: @scope_id) : current_participatory_space.scope
+        end
+
+        # Scope identifier
+        #
+        # Returns the scope identifier related to the plan
+        def scope_id
+          @scope_id || scope&.id
+        end
+
+        def author
+          current_organization
+        end
+
+        def proposals
+          @proposals ||= Decidim
+                         .find_resource_manifest(:proposals)
+                         .try(:resource_scope, current_component)
+                         &.where(id: proposal_ids)
+                         &.order(title: :asc)
+        end
+
+        private
+
+        def scope_belongs_to_participatory_space_scope
+          errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/admin/plan_sections_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A form object to be used when admin users want to create a plan.
+      class PlanSectionsForm < Decidim::Form
+        include Decidim::ApplicationHelper
+
+        attribute :sections, Array[SectionForm]
+
+        def map_model(sections)
+          self.sections = sections.map do |section|
+            SectionForm.from_model(section)
+          end
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/admin/section_form.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # A form object to be used when admin users want to create a plan.
+      class SectionForm < Decidim::Form
+        include TranslatableAttributes
+        include Decidim::ApplicationHelper
+
+        mimic :section
+
+        translatable_attribute :body, String
+        translatable_attribute :help, String
+        attribute :mandatory, Boolean, default: false
+        attribute :answer_length, Integer, default: 0
+        attribute :section_type, String
+        attribute :position, Integer
+        attribute :deleted, Boolean, default: false
+
+        validates :position, numericality: { greater_than_or_equal_to: 0 }
+        validates :body, translatable_presence: true, unless: :deleted
+        validates :answer_length, numericality: {
+          greater_than_or_equal_to: 0,
+          only_integer: true
+        }
+
+        def to_param
+          id || "section-id"
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/attachment_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    class AttachmentForm < Decidim::Form
+      attribute :title, String
+      attribute :file
+      attribute :weight, Integer
+      attribute :deleted, Boolean, default: false
+
+      mimic :attachment
+
+      validates :title, presence: true, if: ->(form) { form.file.present? || form.id.present? }
+
+      def to_param
+        id || "attachment-id"
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/content_form.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A form object to be used when admin users want to create or edit
+    # a plan content field.
+    class ContentForm < Decidim::Form
+      include OptionallyTranslatableAttributes
+      include Decidim::TranslationsHelper
+
+      mimic :content
+
+      alias component current_component
+
+      optionally_translatable_attribute :body, String
+      attribute :section_id, Integer
+      attribute :plan_id, Integer
+
+      optionally_translatable_validate_presence :body, if: :mandatory
+
+      attr_writer :section
+      attr_writer :plan
+
+      delegate :mandatory, to: :section
+
+      def section
+        @section ||= Decidim::Plans::Section.find(section_id)
+      end
+
+      def plan
+        @plan ||= Decidim::Plans::Plan.find(plan_id)
+      end
+
+      def label
+        translated_attribute(section.body)
+      end
+
+      def help
+        translated_attribute(section.help)
+      end
+
+      # Public: Map the correct fields.
+      #
+      # Returns nothing.
+      def map_model(model)
+        self.section_id = model.decidim_section_id
+        self.section = model.section
+
+        self.plan_id = model.decidim_plan_id
+        self.plan = model.plan
+      end
+
+      def deleted?
+        false
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/plan_form.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A form object to be used when public users want to create a Plan.
+    class PlanForm < Decidim::Form
+      include OptionallyTranslatableAttributes
+      mimic :plan
+
+      alias component current_component
+
+      optionally_translatable_attribute :title, String
+
+      attribute :user_group_id, Integer
+      attribute :category_id, Integer
+      attribute :scope_id, Integer
+      attribute :attachments, Array[Plans::AttachmentForm]
+      attribute :contents, Array[ContentForm]
+      attribute :proposal_ids, Array[Integer]
+
+      validates :proposals, presence: true
+      validates :category, presence: true, if: ->(form) { form.category_id.present? }
+      validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+      optionally_translatable_validate_presence :title
+
+      validate :scope_belongs_to_participatory_space_scope
+
+      delegate :categories, to: :current_component
+
+      # Finds the Category from the category_id.
+      #
+      # Returns a Decidim::Category
+      def category
+        @category ||= categories.find_by(id: category_id)
+      end
+
+      # Finds the Scope from the given decidim_scope_id, uses participatory space scope if missing.
+      #
+      # Returns a Decidim::Scope
+      def scope
+        @scope ||= @scope_id ? current_participatory_space.scopes.find_by(id: @scope_id) : current_participatory_space.scope
+      end
+
+      # Scope identifier
+      #
+      # Returns the scope identifier related to the plan
+      def scope_id
+        @scope_id || scope&.id
+      end
+
+      def map_model(model)
+        self.contents = model.sections.map do |section|
+          ContentForm.from_model(
+            Content
+              .where(plan: model, section: section)
+              .first_or_initialize(plan: model, section: section)
+          )
+        end
+
+        self.user_group_id = model.user_groups.first&.id
+        return unless model.categorization
+
+        self.category_id = model.categorization.decidim_category_id
+      end
+
+      def user_group
+        @user_group ||= Decidim::UserGroup.find user_group_id if user_group_id.present?
+      end
+
+      def proposals
+        @proposals ||= Decidim
+                       .find_resource_manifest(:proposals)
+                       .try(:resource_scope, current_component)
+                       &.where(id: proposal_ids)
+                       &.order(title: :asc)
+      end
+
+      private
+
+      def scope_belongs_to_participatory_space_scope
+        errors.add(:scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
+      end
+    end
+  end
+end

data/app/forms/decidim/plans/reject_access_to_plan_form.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A form object to be used when Plan editors rejects a request to acces it.
+    class RejectAccessToPlanForm < AccessToPlanForm
+    end
+  end
+end

data/app/forms/decidim/plans/request_access_to_plan_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # A form object to be used when public users want to request acces to a Plan.
+    class RequestAccessToPlanForm < Decidim::Form
+      mimic :plan
+
+      attribute :id, String
+      attribute :state, String
+
+      validates :id, presence: true
+      validates :state, presence: true, inclusion: { in: %w(open) }
+
+      def plan
+        @plan ||= Decidim::Plans::Plan.find id
+      end
+    end
+  end
+end

data/app/helpers/decidim/plans/admin/application_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module Admin
+      # Custom helpers, scoped to the forms engine.
+      #
+      module ApplicationHelper
+        def tabs_id_for_section(section)
+          "section_#{section.to_param}"
+        end
+
+        def tabs_id_for_content(idx)
+          "content_#{idx}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # Custom helpers, scoped to the plans engine.
+    #
+    module ApplicationHelper
+      include Decidim::Comments::CommentsHelper
+      include PaginateHelper
+      include Decidim::MapHelper
+
+      # Public: The state of a plan in a way a human can understand.
+      #
+      # state - The String state of the plan.
+      #
+      # Returns a String.
+      def humanize_plan_state(state)
+        I18n.t(state, scope: "decidim.plans.answers", default: :not_answered)
+      end
+
+      # Public: The css class applied based on the plan state.
+      #
+      # state - The String state of the plan.
+      #
+      # Returns a String.
+      def plan_state_css_class(state)
+        case state
+        when "accepted"
+          "text-success"
+        when "rejected"
+          "text-alert"
+        when "evaluating"
+          "text-warning"
+        when "withdrawn"
+          "text-alert"
+        else
+          "text-info"
+        end
+      end
+
+      def current_user_plans
+        Plan.joins(:coauthorships).where(
+          component: current_component,
+          decidim_coauthorships: {
+            decidim_author_id: current_user.id,
+            decidim_author_type: "Decidim::UserBaseEntity"
+          }
+        )
+      end
+
+      def authors_for(plan)
+        plan.identities.map { |identity| present(identity) }
+      end
+
+      def filter_state_values
+        [
+          ["except_rejected", t("decidim.plans.application_helper.filter_state_values.except_rejected")],
+          ["accepted", t("decidim.plans.application_helper.filter_state_values.accepted")],
+          ["evaluating", t("decidim.plans.application_helper.filter_state_values.evaluating")],
+          ["rejected", t("decidim.plans.application_helper.filter_state_values.rejected")],
+          ["all", t("decidim.plans.application_helper.filter_state_values.all")]
+        ]
+      end
+
+      def filter_type_values
+        [
+          ["all", t("decidim.plans.application_helper.filter_type_values.all")],
+          ["plans", t("decidim.plans.application_helper.filter_type_values.plans")],
+          ["amendments", t("decidim.plans.application_helper.filter_type_values.amendments")]
+        ]
+      end
+
+      def tabs_id_for_content(idx)
+        "content_#{idx}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module AttachedProposalsHelper
+      include Decidim::ApplicationHelper
+
+      def attached_proposals_picker_field(form, name)
+        picker_options = {
+          id: "attached_proposals",
+          "class": "picker-multiple",
+          name: "proposal_ids",
+          multiple: true
+        }
+
+        prompt_params = {
+          url: plan_search_proposals_path(current_component, format: :html),
+          text: t("decidim.plans.attached_proposals_helper.attach_proposal")
+        }
+
+        form.data_picker(name, picker_options, prompt_params) do |item|
+          { url: plan_search_proposals_path(current_component, format: :json),
+            text: item.title }
+        end
+      end
+
+      def search_proposals
+        respond_to do |format|
+          format.html do
+            render partial: "decidim/plans/attached_proposals/proposals"
+          end
+          format.json do
+            query = Decidim
+                    .find_resource_manifest(:proposals)
+                    .try(:resource_scope, current_component)
+                    &.order(title: :asc)
+                    &.where("title ilike ?", "%#{params[:term]}%")
+            render json: query.all.collect { |p| [present(p).title, p.id] }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module AttachmentsHelper
+      def tabs_id_for_attachment(attachment)
+        "attachment_#{attachment.to_param}"
+      end
+
+      def blank_attachment
+        @blank_attachment ||= Plans::AttachmentForm.new
+      end
+
+      # A modified version of the Decidim's own form builder `upload` method
+      # which is buggy for multiple file fields.
+      #
+      # See:
+      # Decidim::FormBuilder#upload
+      #
+      # form         - The form object for which to create the field.
+      # attribute    - The String/Symbol name of the attribute to build the
+      #                field.
+      def upload_field(form, attribute)
+        file = form.object.send attribute
+        required = file.nil?
+
+        label_content = form.label_for(attribute)
+        label_content += required_tag if required
+        template = ""
+        template += form.label(attribute, label_content)
+        template += form.file_field attribute, label: false
+
+        if form.send(:file_is_image?, file)
+          template += if file.present?
+                        content_tag :label, I18n.t("current_image", scope: "decidim.forms")
+                      else
+                        content_tag :label, I18n.t("default_image", scope: "decidim.forms")
+                      end
+          template += link_to image_tag(file.url), file.url, target: "_blank"
+        elsif form.send(:file_is_present?, file)
+          template += label_tag I18n.t("current_file", scope: "decidim.forms")
+          template += link_to file.file.filename, file.url, target: "_blank"
+        end
+
+        template.html_safe
+      end
+
+      def required_tag
+        content_tag(
+          :abbr,
+          "*",
+          title: I18n.t("required", scope: "forms"),
+          data: { tooltip: true, disable_hover: false }, 'aria-haspopup': true,
+          class: "label-required"
+        ).html_safe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module CellsHelper
+      def plans_controller?
+        context[:controller].class.to_s == "Decidim::Plans::PlansController"
+      end
+
+      def withdrawable?
+        return unless from_context
+        return unless plans_controller?
+        return if index_action?
+        from_context.withdrawable_by?(current_user)
+      end
+
+      def flagable?
+        return unless from_context
+        return unless plans_controller?
+        return if index_action?
+        return if from_context.try(:official?)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    # Custom helpers, scoped to the plans engine.
+    #
+    module PlanCellsHelper
+      include Decidim::Plans::ApplicationHelper
+      include Decidim::Plans::Engine.routes.url_helpers
+      include Decidim::LayoutHelper
+      include Decidim::ApplicationHelper
+      include Decidim::TranslationsHelper
+      include Decidim::ResourceReferenceHelper
+      include Decidim::TranslatableAttributes
+      include Decidim::CardHelper
+
+      delegate :title, :state, :answered?, :withdrawn?, to: :model
+
+      def has_actions?
+        false
+      end
+
+      def plans_controller?
+        context[:controller].class.to_s == "Decidim::Plans::PlansController"
+      end
+
+      def index_action?
+        context[:controller].action_name == "index"
+      end
+
+      def current_settings
+        model.component.current_settings
+      end
+
+      def component_settings
+        model.component.settings
+      end
+
+      def current_component
+        model.component
+      end
+
+      def from_context
+        @options[:from]
+      end
+
+      def badge_name
+        humanize_plan_state state
+      end
+
+      def state_classes
+        case state
+        when "accepted"
+          ["success"]
+        when "rejected"
+          ["alert"]
+        when "evaluating"
+          ["warning"]
+        when "withdrawn"
+          ["alert"]
+        else
+          ["muted"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Plans
+    module RemainingCharactersHelper
+      def remaining_characters(attribute, num_characters)
+        return unless block_given?
+
+        field_opts = {}
+        if num_characters.positive?
+          remaining_characters_id = "#{attribute}_remaining_characters"
+          field_opts = {
+            maxlength: num_characters,
+            data: {
+              remaining_characters: "##{remaining_characters_id}"
+            }
+          }
+        end
+
+        field = capture do
+          yield field_opts
+        end
+        chars_elem = render(
+          "decidim/plans/shared/remaining_characters_container",
+          remaining_characters_id: remaining_characters_id
+        )
+
+        field + chars_elem
+      end
+    end
+  end
+end