decidim-participatory_documents 0.2.0

data/app/commands/decidim/participatory_documents/admin/destroy_annotation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class DestroyAnnotation < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form, document)
+          @form = form
+          @document = document
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          begin
+            @old_section = annotation.section
+            transaction do
+              destroy_annotation!
+            end
+
+            destroy_old_section!
+            document.update_positions!
+
+            broadcast(:ok)
+          rescue ActiveRecord::RecordInvalid
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :document
+
+        def destroy_annotation!
+          Decidim.traceability.perform_action!(
+            :delete,
+            annotation,
+            form.current_user
+          ) do
+            annotation.destroy!
+          end
+        end
+
+        # Destroys the old section if has no more annotations
+        def destroy_old_section!
+          return unless @old_section
+          return if @old_section.annotations.reload.any?
+
+          Decidim.traceability.perform_action!(
+            :delete,
+            @old_section,
+            form.current_user
+          ) do
+            @old_section.destroy!
+          end
+        end
+
+        def annotation
+          @annotation ||= document.annotations.find(form.id)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/notify_suggestion_answer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class NotifySuggestionAnswer < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # suggestion - The suggestion to write the answer for.
+        # initial_state - The suggestion state before the current process.
+        def initialize(suggestion, initial_state)
+          @suggestion = suggestion
+          @initial_state = initial_state.to_s
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :noop when the answer is not published or the state didn't changed.
+        # - :ok when everything is valid.
+        #
+        # Returns nothing.
+        def call
+          broadcast(:invalid) unless suggestion.has_answer? && suggestion.answered? && suggestion.answer_is_published?
+
+          notify_followers
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :suggestion, :initial_state
+
+        def notify_followers
+          publish_event(
+            "decidim.events.participatory_documents.suggestion_answered",
+            Decidim::ParticipatoryDocuments::SuggestionAnswerEvent
+          )
+        end
+
+        def publish_event(event, event_class)
+          Decidim::EventsManager.publish(
+            event: event,
+            event_class: event_class,
+            resource: suggestion,
+            affected_users: [suggestion.author]
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/publish_answers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class PublishAnswers < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # component - The component that contains the answers.
+        # user - the Decidim::User that is publishing the answers.
+        # proposal_ids - the identifiers of the suggestions with the answers to be published.
+        def initialize(component, user, suggestion_ids)
+          @component = component
+          @user = user
+          @suggestion_ids = suggestion_ids
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if there are not proposals to publish.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless suggestions.any?
+
+          suggestions.each do |suggestion|
+            suggestion.assign_attributes(answered_at: Time.current, answer_is_published: true)
+
+            if suggestion.answer_is_published_changed?
+              Decidim.traceability.perform_action!("publish_answer", suggestion, user) { suggestion.save! }
+              notify_user(suggestion)
+            end
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        def notify_user(suggestion)
+          suggestion.reload
+          return unless suggestion.has_answer?
+
+          NotifySuggestionAnswer.call(suggestion, nil)
+        end
+
+        attr_reader :component, :user, :suggestion_ids
+
+        def suggestions
+          @suggestions || Decidim::ParticipatoryDocuments::Suggestion
+            # .not_published
+            # .having_text_answer
+            .where(id: suggestion_ids)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/publish_document.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class PublishDocument < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # document - The document to publish.
+        def initialize(document)
+          @document = document
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # Returns nothing.
+        def call
+          @document.publish!
+
+          broadcast(:ok)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/unassign_suggestions_from_valuator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class UnassignSuggestionsFromValuator < Decidim::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.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless form.valid?
+
+          unassign_suggestions
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form
+
+        def unassign_suggestions
+          transaction do
+            form.suggestions.flat_map do |suggestion|
+              assignment = find_assignment(suggestion)
+              unassign(assignment) if assignment
+            end
+          end
+        end
+
+        def find_assignment(suggestion)
+          Decidim::ParticipatoryDocuments::ValuationAssignment.find_by(
+            suggestion: suggestion,
+            valuator_role: form.valuator_role
+          )
+        end
+
+        def unassign(assignment)
+          Decidim.traceability.perform_action!(
+            :delete,
+            assignment,
+            form.current_user,
+            suggestion: assignment.suggestion.id
+          ) do
+            assignment.destroy!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/update_document.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class UpdateDocument < Decidim::Command
+        include ::Decidim::AttachmentAttributesMethods
+
+        def initialize(form, document)
+          @form = form
+          @document = document
+          @attached_to = document
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          begin
+            transaction do
+              destroy_sections!
+              update_document
+            end
+            broadcast(:ok, document)
+          rescue ActiveRecord::RecordNotDestroyed => e
+            # if sections contains annotations, can be deleted
+            # if sections contains suggestions, cannot be deleted
+            broadcast(:error, e.message)
+          rescue ActiveRecord::RecordInvalid
+            form.errors.add(:file, document.errors[:file]) if document.errors.include? :file
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :document
+
+        def attributes
+          {
+            title: form.title,
+            description: form.description,
+            box_color: form.box_color,
+            box_opacity: form.box_opacity
+          }.merge(attachment_attributes(:file))
+        end
+
+        def update_document
+          Decidim.traceability.update!(
+            document,
+            form.current_user,
+            **attributes
+          )
+        end
+
+        def destroy_sections!
+          return if form.file.blank?
+
+          raise ActiveRecord::RecordNotDestroyed, I18n.t("activemodel.errors.models.document.has_suggestions") if document.has_suggestions?
+
+          return unless document.sections.any?
+
+          document.annotations.each do |annotation|
+            Decidim.traceability.perform_action!(
+              "delete",
+              annotation,
+              current_user
+            ) do
+              annotation.destroy!
+            end
+          end
+
+          document.sections.each do |section|
+            Decidim.traceability.perform_action!(
+              "delete",
+              section,
+              current_user
+            ) do
+              section.destroy!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/update_or_create_annotation.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class UpdateOrCreateAnnotation < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form, document)
+          @form = form
+          @document = document
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+          return broadcast(:invalid) if document.nil?
+
+          begin
+            @old_section = annotation.present? ? annotation.section : nil
+
+            transaction do
+              create_section! if section.blank?
+              create_annotation! if annotation.blank?
+              annotation.assign_attributes(**attributes)
+              update_annotation! if annotation.changed?
+            end
+
+            destroy_old_section!
+            document.update_positions!
+
+            broadcast(:ok, annotation)
+          rescue ActiveRecord::RecordInvalid
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :document
+
+        def update_annotation!
+          @annotation = Decidim.traceability.update!(
+            annotation,
+            form.current_user,
+            **attributes
+          )
+        end
+
+        def create_annotation!
+          @annotation = Decidim.traceability.create!(
+            Decidim::ParticipatoryDocuments::Annotation,
+            form.current_user,
+            **attributes
+          )
+        end
+
+        def create_section!
+          @section = Decidim.traceability.create!(
+            Decidim::ParticipatoryDocuments::Section,
+            form.current_user,
+            document: document
+          )
+        end
+
+        # Destroys the old section if has no more annotations
+        def destroy_old_section!
+          return unless @old_section
+          return if @old_section.annotations.reload.any?
+
+          Decidim.traceability.perform_action!(
+            :delete,
+            @old_section,
+            form.current_user
+          ) do
+            @old_section.destroy!
+          end
+        end
+
+        def attributes
+          {
+            page_number: form.page_number,
+            rect: form.rect,
+            section: section
+          }
+        end
+
+        def section
+          @section ||= document.sections.find_by(id: form.section)
+        end
+
+        def annotation
+          @annotation ||= document.annotations.find_by(id: form.id)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/update_section.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class UpdateSection < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form, document)
+          @form = form
+          @document = document
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          begin
+            transaction do
+              update_section
+            end
+            broadcast(:ok, section)
+          rescue ActiveRecord::RecordInvalid
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :document
+
+        def update_section
+          @zone = Decidim.traceability.update!(
+            section,
+            form.current_user,
+            **attributes
+          )
+        end
+
+        def attributes
+          {
+            title: form.title
+          }.merge(document: document)
+        end
+
+        def section
+          @section ||= document.sections.find(form.id)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/update_suggestion_note.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      # A command with all the business logic when a user updates a suggestion note.
+      class UpdateSuggestionNote < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # note - the suggestion note to update.
+        def initialize(notes_form, note)
+          @notes_form = notes_form
+          @note = note
+        end
+
+        def call
+          return broadcast(:invalid) if notes_form.invalid?
+
+          update_suggestion_note
+
+          broadcast(:ok, note)
+        end
+
+        private
+
+        attr_reader :notes_form, :note, :suggestion
+
+        def update_suggestion_note
+          note.body = notes_form.body
+          note.save!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/create_suggestion.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class CreateSuggestion < Decidim::Command
+      include ::Decidim::AttachmentMethods
+
+      def initialize(form, suggestable)
+        @form = form
+        @suggestable = suggestable
+      end
+
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        begin
+          transaction do
+            create_suggestion
+          end
+          broadcast(:ok, suggestion)
+        rescue ActiveRecord::RecordInvalid => e
+          Rails.logger.info e.message
+          broadcast(:invalid, e.message)
+        end
+      end
+
+      private
+
+      attr_reader :form, :suggestion, :suggestable
+
+      def create_suggestion
+        @suggestion = Decidim.traceability.create!(
+          Decidim::ParticipatoryDocuments::Suggestion,
+          form.current_user,
+          { body: { I18n.locale => form.body },
+            suggestable: suggestable,
+            author: form.current_user },
+          visibility: "public-only"
+        )
+
+        create_suggestion_attachment if form.file.present?
+      end
+
+      def create_suggestion_attachment
+        file = form.file
+        file_blob = ActiveStorage::Blob.create_after_upload!(
+          io: file.open,
+          filename: file.original_filename,
+          content_type: file.content_type
+        )
+
+        attachment = Decidim::Attachment.create!(
+          file: file_blob,
+          attached_to: suggestion,
+          content_type: file.content_type,
+          title: { I18n.locale => file.original_filename }
+        )
+
+        suggestion.file.attach(attachment.file.blob)
+
+        suggestion.save!
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/participatory_documents/admin/needs_admin_snippets.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      # This module adds custom javascript and css for the admin controllers related to participatory documents
+      module NeedsAdminSnippets
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :add_snippets
+
+          private
+
+          def add_snippets
+            return unless respond_to?(:snippets)
+
+            snippets.add(:head, helpers.stylesheet_pack_tag("decidim_participatory_documents_admin"))
+            snippets.add(:foot, helpers.javascript_pack_tag("decidim_participatory_documents_admin"))
+          end
+        end
+      end
+    end
+  end
+end