decidim-participatory_documents 0.2.0

data/app/controllers/decidim/participatory_documents/section_suggestions_controller.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class SectionSuggestionsController < Decidim::ParticipatoryDocuments::ApplicationController
+      include FormFactory
+      include Paginable
+
+      helper_method :section, :suggestions
+      layout false
+
+      def index
+        @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).instance
+      end
+
+      def create
+        @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).from_params(params)
+
+        CreateSuggestion.call(@form, section) do
+          on(:ok) do |_suggestion|
+            redirect_to(document_section_suggestions_path(document, section.id)) && return
+          end
+          on(:invalid) do
+            render template: "decidim/participatory_documents/section_suggestions/index", format: [:html], status: :bad_request
+          end
+        end
+      end
+
+      private
+
+      def suggestions
+        @suggestions ||= section.suggestions.where(author: current_user).order(created_at: :asc)
+      end
+
+      def section
+        @section ||= document.sections.find(params[:section_id])
+      end
+    end
+  end
+end

data/app/events/decidim/participatory_documents/suggestion_answer_event.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class SuggestionAnswerEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+
+      def resource_path
+        @resource_path ||= if resource.suggestable.is_a?(Decidim::ParticipatoryDocuments::Document)
+                             main_component_path(resource.suggestable.component)
+                           else
+                             main_component_path(resource.suggestable.document.component)
+                           end
+      end
+
+      def resource_url
+        @resource_url ||= if resource.suggestable.is_a?(Decidim::ParticipatoryDocuments::Document)
+                            main_component_url(resource.suggestable.component)
+                          else
+                            main_component_url(resource.suggestable.document.component)
+                          end
+      end
+
+      def resource_title
+        title ||= if resource.suggestable.is_a?(Decidim::ParticipatoryDocuments::Document)
+                    translated_attribute(resource.suggestable.title)
+                  else
+                    translated_attribute(resource.suggestable.document.title)
+                  end
+
+        Decidim::ContentProcessor.render_without_format(title, links: false).html_safe
+      end
+
+      def event_has_roles?
+        true
+      end
+
+      def resource_text
+        translated_attribute(resource.answer)
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/admin/annotation_form.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class AnnotationForm < Decidim::Form
+        mimic :annotation
+
+        attribute :id, Integer
+        attribute :rect, Hash
+        attribute :page_number, Integer
+        attribute :section, Integer
+
+        validate :rect_valid_hash
+
+        private
+
+        def rect_valid_hash
+          return if rect[:left] && rect[:top]
+
+          errors.add(:rect, :invalid)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/admin/answer_suggestion_form.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class AnswerSuggestionForm < Decidim::Form
+        include TranslatableAttributes
+        translatable_attribute :answer, String
+        attribute :state, String, default: "not_answered"
+        attribute :answer_is_published, Boolean, default: false
+
+        validates :state, presence: true, inclusion: { in: %w(not_answered accepted rejected evaluating) }, unless: ->(form) { form.answer_is_published? }
+        validates :state, presence: true, inclusion: { in: %w(accepted rejected evaluating) }, if: ->(form) { form.answer_is_published? }
+
+        def answer_is_published?
+          answer_is_published == true
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/admin/document_form.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class DocumentForm < Decidim::Form
+        include Decidim::HasUploadValidations
+        include Decidim::TranslatableAttributes
+
+        mimic :document
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+
+        attribute :box_color, String, default: "#1e98d7"
+        attribute :box_opacity, Integer, default: 12
+
+        attribute :file
+        attribute :remove_file, Boolean, default: false
+
+        # ensure color and opacity are present
+        def map_model(doc)
+          self.box_color = doc.box_color.presence || "#1e98d7"
+          self.box_opacity = doc.box_opacity.presence || 12
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class SectionForm < Decidim::Form
+        include TranslatableAttributes
+
+        mimic :section
+
+        translatable_attribute :title, String
+
+        validates :title, translatable_presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/admin/suggestion_note_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class SuggestionNoteForm < Decidim::Form
+        mimic :suggestion_note
+
+        attribute :body, String
+
+        validates :body, presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/admin/valuation_assignment_form.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class ValuationAssignmentForm < Decidim::Form
+        mimic :valuator_role
+
+        attribute :id, Integer
+        attribute :suggestion_ids, Array
+
+        validates :valuator_role, :suggestions, :current_component, presence: true
+        validate :same_participatory_space
+
+        def suggestions
+          # here we need to check for component
+          @suggestions ||= Decidim::ParticipatoryDocuments::Suggestion.where(id: suggestion_ids).uniq.filter { |suggestion| suggestion.component == current_component }
+        end
+
+        def valuator_role
+          @valuator_role ||= current_component.participatory_space.user_roles(:valuator).find_by(id: id)
+        end
+
+        def valuator_user
+          return unless valuator_role
+
+          @valuator_user ||= valuator_role.user
+        end
+
+        def same_participatory_space
+          return if !valuator_role || !current_component
+
+          errors.add(:id, :invalid) if current_component.participatory_space != valuator_role.participatory_space
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/participatory_documents/suggestion_form.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class SuggestionForm < Decidim::Form
+      include Decidim::AttachmentAttributes
+      include Decidim::HasUploadValidations
+
+      attribute :body, String
+      attribute :file
+
+      validate :validate_single_field_presence
+      validate :validate_body_length
+
+      private
+
+      def validate_body_length
+        return if body.blank?
+
+        errors.add(:body, I18n.t("activemodel.errors.models.suggestion.attributes.too_short", min_length: min_length)) if body.length < min_length
+        errors.add(:body, I18n.t("activemodel.errors.models.suggestion.attributes.too_long", max_length: max_length)) if body.length > max_length
+      end
+
+      def validate_single_field_presence
+        return unless body.blank? && file.blank?
+
+        errors.add(:body, I18n.t("activemodel.errors.models.suggestion.attributes.not_blank"))
+      end
+
+      def min_length
+        current_component.settings.min_suggestion_length || Decidim::ParticipatoryDocuments.config.min_suggestion_length
+      end
+
+      def max_length
+        current_component.settings.max_suggestion_length || Decidim::ParticipatoryDocuments.config.max_suggestion_length
+      end
+    end
+  end
+end

data/app/helpers/decidim/participatory_documents/admin/button_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      module ButtonHelper
+        def button_builder(btn_title, icon: "document")
+          btn_icon(icon, btn_title) + content_tag(:span, btn_title)
+        end
+
+        def btn_icon(icon, label)
+          icon(icon, class: "icon--document icon icon icon-document mr-xs", aria_label: label, role: "img")
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/participatory_documents/admin/documents_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      module DocumentsHelper
+        include ButtonHelper
+
+        def pdf_manage_buttons(document)
+          content_tag(:div, class: "flex--cc flex-gap--1") do
+            if document.blank? && allowed_to?(:create, :participatory_document)
+              new_pdf_btn
+            elsif document.file.attached? && allowed_to?(:update, :participatory_document, document: document)
+              edit_document_btn + edit_boxes_btn + preview_sections_btn
+            elsif allowed_to?(:update, :participatory_document, document: document)
+              edit_document_btn
+            end
+          end
+        end
+
+        def back_btn
+          btn_title = t("actions.back", scope: "decidim.participatory_documents")
+
+          content_tag(:a, title: btn_title, href: manage_component_path(current_component), class: "button small button--simple") do
+            button_builder(btn_title, icon: "caret-left")
+          end
+        end
+
+        def boolean_label(active)
+          content_tag(:span, class: "label #{active ? "success" : "alert"}") do
+            t(active ? "yes" : "no", scope: "decidim.participatory_documents")
+          end
+        end
+
+        private
+
+        def preview_sections_btn
+          btn_title = t("actions.preview_publishing_sections", scope: "decidim.participatory_documents")
+
+          content_tag(:a, title: btn_title, href: main_component_path(document.component), class: "button small success") do
+            button_builder(btn_title, icon: "eye")
+          end
+        end
+
+        def new_pdf_btn
+          btn_title = t("actions.new", scope: "decidim.participatory_documents")
+
+          content_tag(:a, title: btn_title, href: new_document_path, class: "button button--simple") do
+            button_builder(btn_title)
+          end
+        end
+
+        def edit_boxes_btn
+          btn_title = t("actions.edit_boxes", scope: "decidim.participatory_documents")
+
+          content_tag(:a, title: btn_title, href: edit_pdf_documents_path(id: document.id), class: "button small warning") do
+            button_builder(btn_title, icon: "layers")
+          end
+        end
+
+        def edit_document_btn
+          btn_title = t("actions.edit_document", scope: "decidim.participatory_documents")
+
+          content_tag(:a, title: btn_title, href: edit_document_path(id: document.id), class: "button small alert") do
+            button_builder(btn_title)
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/participatory_documents/admin/suggestion_helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      module SuggestionHelper
+        include ActionView::Helpers::TextHelper
+        include Decidim::Admin::IconLinkHelper
+
+        def humanize_suggestion_state(state)
+          I18n.t(state, scope: "decidim.participatory_documents.suggestions.answers", default: :not_answered)
+        end
+
+        def icon_with_link_to_suggestion(document, suggestion)
+          return unless allowed_to?(:create, :suggestion_note, suggestion: suggestion) || allowed_to?(:update, :suggestion_answer, suggestion: suggestion)
+
+          icon_link_to("comment-square",
+                       document_suggestion_path(document, suggestion),
+                       t(:answer, scope: "decidim.participatory_documents.admin.suggestions.index.actions"),
+                       class: "icon--small action-icon--show-suggestion")
+        end
+
+        def bulk_valuators_select(participatory_space, prompt)
+          options_for_select = find_valuators_for_select(participatory_space)
+          select(:valuator_role, :id, options_for_select, prompt: prompt)
+        end
+
+        def suggestion_content(suggestion)
+          {
+            text: suggestion_body(suggestion),
+            file_link: suggestion.file.attached? && file_link(suggestion)
+          }
+        end
+
+        private
+
+        def file_link(suggestion)
+          icon_link_to("data-transfer-download",
+                       Rails.application.routes.url_helpers.rails_blob_url(suggestion.file.blob, only_path: true, target: "_blank", rel: "noopener"),
+                       t("decidim.participatory_documents.admin.suggestions.index.actions.download", filename: suggestion.file.filename.to_s),
+                       class: "icon--small ml-xs")
+        end
+
+        def content_with_class(content, css_class)
+          content_tag(:span, content, class: css_class)
+        end
+
+        def suggestion_body(suggestion)
+          suggestion.body[I18n.locale.to_s].presence || content_with_class(t("decidim.participatory_documents.admin.suggestions.index.no_text"), "muted")
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/participatory_documents/documents_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module DocumentsHelper
+      include Decidim::ParticipatoryDocuments::Admin::ButtonHelper
+      include Decidim::Admin::UserRolesHelper
+
+      def back_edit_pdf_btn
+        btn_title = t("actions.back_edit", scope: "decidim.participatory_documents")
+
+        content_tag(:a,
+                    title: btn_title,
+                    href: Decidim::EngineRouter.admin_proxy(document.component).edit_pdf_documents_path(id: document.id),
+                    class: "button small warning mr-s") do
+          button_builder(btn_title, icon: "layers")
+        end
+      end
+
+      def finish_publish_btn
+        btn_title = t("actions.finish_publishing", scope: "decidim.participatory_documents")
+
+        link_to(
+          Decidim::EngineRouter.admin_proxy(document.component).publish_document_path(document),
+          method: :put,
+          data: { confirm: t("actions.confirm", scope: "decidim.participatory_documents") },
+          class: "button small light success"
+        ) do
+          button_builder(btn_title, icon: "check")
+        end
+      end
+
+      def preview_mode?
+        return if document.published?
+        return if current_user.blank?
+
+        current_component.manifest.admin_engine && user_role_config.component_is_accessible?(current_component.manifest_name)
+      end
+    end
+  end
+end

data/app/models/concerns/decidim/participatory_documents/participatory_space_user_role_override.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module ParticipatorySpaceUserRoleOverride
+      extend ActiveSupport::Concern
+      included do
+        # there is a bug in decidim that does not clean records from ValuationAssignment when removing Space roles
+        # This is a workaround to clean them manually
+        # It might be possible that we need to change this when this is solved:
+        # https://github.com/decidim/decidim/issues/10353
+        has_many :suggestion_valuation_assignments,
+                 class_name: "Decidim::ParticipatoryDocuments::ValuationAssignment",
+                 foreign_key: :valuator_role_id,
+                 dependent: :destroy
+      end
+    end
+  end
+end

data/app/models/concerns/decidim/participatory_documents/valuator_override.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module ValuatorOverride
+      extend ActiveSupport::Concern
+
+      included do
+        # it is important to ensure that the aliased method name is unique in case of other modules are doing the same
+        alias_method :decidim_participatory_documents_original_accepted_components, :accepted_components
+
+        def accepted_components
+          decidim_participatory_documents_original_accepted_components + [:participatory_documents]
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/participatory_documents/annotation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class Annotation < ApplicationRecord
+      belongs_to :section, class_name: "Decidim::ParticipatoryDocuments::Section"
+      has_many :suggestions, class_name: "Decidim::ParticipatoryDocuments::Suggestion", dependent: :restrict_with_error, as: :suggestable
+
+      delegate :document, to: :section
+      delegate :organization, :participatory_space, :component, to: :document, allow_nil: true
+
+      def self.log_presenter_class_for(_log)
+        Decidim::ParticipatoryDocuments::AdminLog::AnnotationPresenter
+      end
+
+      def serialize
+        @serialize ||= {
+          id: id,
+          position: position,
+          rect: rect,
+          section: section.id,
+          section_number: section.position,
+          page_number: page_number
+        }
+      end
+    end
+  end
+end

data/app/models/decidim/participatory_documents/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    # Main ActiveRecord application configuration.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/participatory_documents/document.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class Document < ApplicationRecord
+      self.table_name = :decidim_participatory_documents_documents
+
+      include Decidim::HasComponent
+      include Decidim::Authorable
+      include Decidim::Traceable
+      include Decidim::Loggable
+      include Decidim::TranslatableResource
+      include Decidim::HasUploadValidations
+      include Decidim::Publicable
+
+      translatable_fields :title, :description
+
+      has_one_attached :file
+      validates_upload :file, uploader: Decidim::ParticipatoryDocuments::PdfDocumentUploader
+
+      has_many :sections, class_name: "Decidim::ParticipatoryDocuments::Section", dependent: :restrict_with_error
+      has_many :suggestions, class_name: "Decidim::ParticipatoryDocuments::Suggestion", dependent: :restrict_with_error, as: :suggestable
+      has_many :annotations, through: :sections
+
+      attr_accessor :remove_file
+
+      def self.log_presenter_class_for(_log)
+        Decidim::ParticipatoryDocuments::AdminLog::DocumentPresenter
+      end
+
+      def has_suggestions?
+        suggestions.any? || annotations.any? { |annotation| annotation.suggestions.any? }
+      end
+
+      # rubocop:disable Rails/SkipsModelValidations
+      def update_positions!
+        transaction do
+          boxes = annotations.reload.sort do |a, b|
+            if a.page_number == b.page_number
+              if a.rect["top"].to_i == b.rect["top"].to_i
+                a.rect["left"].to_i <=> b.rect["left"].to_i
+              else
+                a.rect["top"].to_i <=> b.rect["top"].to_i
+              end
+            else
+              a.page_number <=> b.page_number
+            end
+          end
+
+          section_number = 0
+          all_sections = {}
+          boxes.each_with_index do |box, index|
+            box.update_column(:position, index + 1)
+            if all_sections[box.section_id]
+              box.section.update_column(:position, all_sections[box.section_id])
+            else
+              section_number += 1
+              box.section.update_column(:position, section_number)
+            end
+            all_sections[box.section_id] = section_number
+          end
+        end
+      end
+      # rubocop:enable Rails/SkipsModelValidations
+    end
+  end
+end

data/app/models/decidim/participatory_documents/section.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class Section < ApplicationRecord
+      include Decidim::Traceable
+      include Decidim::Loggable
+      include Decidim::TranslatableResource
+      include Decidim::TranslatableAttributes
+      include Decidim::Publicable
+
+      belongs_to :document, class_name: "Decidim::ParticipatoryDocuments::Document"
+      has_many :annotations, class_name: "Decidim::ParticipatoryDocuments::Annotation", dependent: :restrict_with_error
+      has_many :suggestions, class_name: "Decidim::ParticipatoryDocuments::Suggestion", dependent: :restrict_with_error, as: :suggestable
+
+      delegate :organization, :participatory_space, :component, to: :document, allow_nil: true
+
+      translatable_fields :title
+
+      def self.log_presenter_class_for(_log)
+        Decidim::ParticipatoryDocuments::AdminLog::SectionPresenter
+      end
+
+      def title
+        return artificial_title if attributes["title"].nil?
+
+        artificial_title.merge(super.reject { |_key, value| value.blank? })
+      end
+
+      private
+
+      def artificial_title
+        artificial = {}
+        i18n_scope = "decidim.participatory_documents.models.section.fields"
+        default_translation = I18n.with_locale("en") { I18n.t("artificial_tile", scope: i18n_scope, position: position) }
+
+        Decidim.available_locales.map(&:to_s).each do |locale|
+          artificial[locale] = I18n.with_locale(locale) { I18n.t("artificial_tile", scope: i18n_scope, position: position, default: default_translation) }
+        end
+        artificial
+      end
+    end
+  end
+end