decidim-enhanced_textwork 1.0.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # Exposes Paragraphs versions so users can see how a Paragraph/CollaborativeDraft
+    # has been updated through time.
+    class VersionsController < Decidim::EnhancedTextwork::ApplicationController
+      include Decidim::ApplicationHelper
+      include Decidim::ResourceVersionsConcern
+
+      def versioned_resource
+        @versioned_resource ||=
+          if params[:paragraph_id]
+            present(Paragraph.where(component: current_component).find(params[:paragraph_id]))
+          else
+            CollaborativeDraft.where(component: current_component).find(params[:collaborative_draft_id])
+          end
+      end
+    end
+  end
+end

data/app/controllers/decidim/enhanced_textwork/widgets_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class WidgetsController < Decidim::WidgetsController
+      helper EnhancedTextwork::ApplicationHelper
+
+      private
+
+      def model
+        @model ||= Paragraph.where(component: params[:component_id]).find(params[:paragraph_id])
+      end
+
+      def iframe_url
+        @iframe_url ||= paragraph_widget_url(model)
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/accepted_paragraph_event.rb

@@ -0,0 +1,17 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class AcceptedParagraphEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+
+      def resource_text
+        translated_attribute(resource.answer)
+      end
+
+      def event_has_roles?
+        true
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/admin/paragraph_note_created_event.rb

@@ -0,0 +1,27 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      class ParagraphNoteCreatedEvent < Decidim::Events::SimpleEvent
+        include Rails.application.routes.mounted_helpers
+
+        i18n_attributes :admin_paragraph_info_url, :admin_paragraph_info_path
+
+        def admin_paragraph_info_path
+          ResourceLocatorPresenter.new(resource).show
+        end
+
+        def admin_paragraph_info_url
+          decidim_admin_participatory_process_paragraphs.paragraph_url(resource, resource.component.mounted_params)
+        end
+
+        private
+
+        def organization
+          @organization ||= component.participatory_space.organization
+        end
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/admin/update_paragraph_category_event.rb

@@ -0,0 +1,11 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      class UpdateParagraphCategoryEvent < Decidim::Events::SimpleEvent
+        include Decidim::Events::AuthorEvent
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/admin/update_paragraph_scope_event.rb

@@ -0,0 +1,11 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      class UpdateParagraphScopeEvent < Decidim::Events::SimpleEvent
+        include Decidim::Events::AuthorEvent
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_accepted_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessAcceptedEvent < CollaborativeDraftAccessRequestEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_rejected_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessRejectedEvent < CollaborativeDraftAccessRequestEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_request_event.rb

@@ -0,0 +1,27 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessRequestEvent < Decidim::Events::SimpleEvent
+      i18n_attributes :requester_name, :requester_path, :requester_nickname
+
+      delegate :name, to: :requester, prefix: true
+
+      delegate :nickname, to: :requester, prefix: true
+
+      def requester_path
+        requester.profile_path
+      end
+
+      private
+
+      def requester
+        @requester ||= Decidim::UserPresenter.new(rejected_requester_user)
+      end
+
+      def rejected_requester_user
+        @rejected_requester_user ||= Decidim::User.find_by(id: extra[:requester_id])
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_requested_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessRequestedEvent < CollaborativeDraftAccessRequestEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_requester_accepted_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessRequesterAcceptedEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_access_requester_rejected_event.rb

@@ -0,0 +1,8 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftAccessRequesterRejectedEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/collaborative_draft_withdrawn_event.rb

@@ -0,0 +1,29 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CollaborativeDraftWithdrawnEvent < Decidim::Events::SimpleEvent
+      i18n_attributes :author_nickname, :author_name, :author_path
+
+      delegate :nickname, :name, to: :author, prefix: true
+
+      def nickname
+        author_nickname
+      end
+
+      def author_path
+        author.profile_path
+      end
+
+      private
+
+      def author
+        @author ||= Decidim::UserPresenter.new(author_user)
+      end
+
+      def author_user
+        @author_user ||= Decidim::User.find_by(id: extra[:author_id])
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/creation_enabled_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CreationEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/endorsing_enabled_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class EndorsingEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/evaluating_paragraph_event.rb

@@ -0,0 +1,11 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class EvaluatingParagraphEvent < Decidim::Events::SimpleEvent
+      def event_has_roles?
+        true
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/paragraph_endorsed_event.rb

@@ -0,0 +1,33 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class ParagraphEndorsedEvent < Decidim::Events::SimpleEvent
+      i18n_attributes :endorser_nickname, :endorser_name, :endorser_path, :nickname
+
+      delegate :nickname, :name, to: :endorser, prefix: true
+
+      def nickname
+        endorser_nickname
+      end
+
+      def endorser_path
+        endorser.profile_path
+      end
+
+      def resource_text
+        resource.body
+      end
+
+      private
+
+      def endorser
+        @endorser ||= Decidim::UserPresenter.new(endorser_user)
+      end
+
+      def endorser_user
+        @endorser_user ||= Decidim::User.find_by(id: extra[:endorser_id])
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/paragraph_mentioned_event.rb

@@ -0,0 +1,21 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class ParagraphMentionedEvent < Decidim::Events::SimpleEvent
+      include Decidim::ApplicationHelper
+
+      i18n_attributes :mentioned_paragraph_title
+
+      private
+
+      def mentioned_paragraph_title
+        present(mentioned_paragraph).title
+      end
+
+      def mentioned_paragraph
+        @mentioned_paragraph ||= Decidim::EnhancedTextwork::Paragraph.find(extra[:mentioned_paragraph_id])
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/publish_paragraph_event.rb

@@ -0,0 +1,25 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class PublishParagraphEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::CoauthorEvent
+
+      def resource_text
+        resource.body
+      end
+
+      private
+
+      def i18n_scope
+        return super unless participatory_space_event?
+
+        "decidim.events.enhanced_textwork.paragraph_published_for_space"
+      end
+
+      def participatory_space_event?
+        extra[:participatory_space]
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/rejected_paragraph_event.rb

@@ -0,0 +1,17 @@
+# frozen-string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class RejectedParagraphEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+
+      def resource_text
+        translated_attribute(resource.answer)
+      end
+
+      def event_has_roles?
+        true
+      end
+    end
+  end
+end

data/app/events/decidim/enhanced_textwork/voting_enabled_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class VotingEnabledEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/forms/decidim/enhanced_textwork/accept_access_to_collaborative_draft_form.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object to be used when Collaborative Draft editors accept a request
+    # to access it as coauthors.
+    class AcceptAccessToCollaborativeDraftForm < AccessToCollaborativeDraftForm
+    end
+  end
+end

data/app/forms/decidim/enhanced_textwork/access_to_collaborative_draft_form.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object common to accept and reject actions requesters of Collaborative Drafts.
+    class AccessToCollaborativeDraftForm < Decidim::Form
+      mimic :collaborative_draft
+
+      attribute :id, String
+      attribute :requester_user_id, String
+      attribute :state, String
+
+      validates :id, :requester_user_id, presence: true
+      validates :state, presence: true, inclusion: { in: %w(open) }
+
+      validate :existence_of_requester_in_requesters
+
+      def collaborative_draft
+        @collaborative_draft ||= Decidim::EnhancedTextwork::CollaborativeDraft.find id if id
+      end
+
+      def requester_user
+        @requester_user ||= Decidim::User.find_by(id: requester_user_id, organization: current_organization) if requester_user_id
+      end
+
+      private
+
+      def existence_of_requester_in_requesters
+        errors.add(:requester_user_id, :invalid) if collaborative_draft && !collaborative_draft.requesters.exists?(requester_user_id)
+      end
+    end
+  end
+end

data/app/forms/decidim/enhanced_textwork/admin/import_editor_participatory_text_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to import a collection of paragraphs
+      # from a participatory text written in a rich text editor.
+      class ImportEditorParticipatoryTextForm < Decidim::Form
+        include TranslatableAttributes
+
+        # WARNING: consider adding/removing the relative translation key at
+        # decidim.assemblies.admin.new_import.accepted_types when modifying this hash
+        ACCEPTED_MIME_TYPES = Decidim::EnhancedTextwork::DocToMarkdown::ACCEPTED_MIME_TYPES
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+        attribute :content
+
+        validates :title, translatable_presence: true
+        validates :content, presence: true, if: :new_participatory_text?
+
+        # Assume it's a NEW participatory_text if there are no paragraphs
+        # Validate content presence while CREATING paragraphs from content
+        # Allow skipping content validation while UPDATING title/description
+        def new_participatory_text?
+          Decidim::EnhancedTextwork::Paragraph.where(component: current_component).blank?
+        end
+
+        def default_locale
+          current_participatory_space.organization.default_locale
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/enhanced_textwork/admin/import_participatory_text_form.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to import a collection of paragraphs
+      # from a participatory text.
+      class ImportParticipatoryTextForm < Decidim::Form
+        include TranslatableAttributes
+        include Decidim::HasUploadValidations
+
+        # WARNING: consider adding/removing the relative translation key at
+        # decidim.assemblies.admin.new_import.accepted_types when modifying this hash
+        ACCEPTED_MIME_TYPES = Decidim::EnhancedTextwork::DocToMarkdown::ACCEPTED_MIME_TYPES
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+        attribute :document
+
+        validates :title, translatable_presence: true
+        validates :document, presence: true, if: :new_participatory_text?
+        validate :document_type_must_be_valid, if: :document
+
+        # Assume it's a NEW participatory_text if there are no paragraphs
+        # Validate document presence while CREATING paragraphs from document
+        # Allow skipping document validation while UPDATING title/description
+        def new_participatory_text?
+          Decidim::EnhancedTextwork::Paragraph.where(component: current_component).blank?
+        end
+
+        def document_type_must_be_valid
+          return if valid_mime_types.include?(document_type)
+
+          errors.add(:document, i18n_invalid_document_type_text)
+        end
+
+        # Return ACCEPTED_MIME_TYPES plus `text/plain` for better markdown support
+        def valid_mime_types
+          ACCEPTED_MIME_TYPES.values + [Decidim::EnhancedTextwork::DocToMarkdown::TEXT_PLAIN_MIME_TYPE] + ["application/octet-stream"]
+        end
+
+        def document_type
+          document.content_type
+        end
+
+        def i18n_invalid_document_type_text
+          I18n.t("invalid_document_type",
+                 scope: "activemodel.errors.models.participatory_text.attributes.document",
+                 valid_mime_types: i18n_valid_mime_types_text)
+        end
+
+        def i18n_valid_mime_types_text
+          ACCEPTED_MIME_TYPES.keys.map do |mime_type|
+            I18n.t(mime_type, scope: "decidim.enhanced_textwork.admin.participatory_texts.new_import.accepted_mime_types")
+          end.join(", ")
+        end
+
+        def default_locale
+          current_participatory_space.organization.default_locale
+        end
+
+        def document_text
+          @document_text ||= document&.read
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/enhanced_textwork/admin/paragraph_answer_form.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to answer a paragraph.
+      class ParagraphAnswerForm < Decidim::Form
+        include TranslatableAttributes
+        mimic :paragraph_answer
+
+        translatable_attribute :answer, String
+        translatable_attribute :cost_report, String
+        translatable_attribute :execution_period, String
+        attribute :cost, Float
+        attribute :internal_state, String
+
+        validates :internal_state, presence: true, inclusion: { in: %w(accepted rejected evaluating) }
+        validates :answer, translatable_presence: true, if: ->(form) { form.state == "rejected" }
+
+        with_options if: :costs_required? do
+          validates :cost, numericality: true, presence: true
+          validates :cost_report, translatable_presence: true
+          validates :execution_period, translatable_presence: true
+        end
+
+        alias state internal_state
+
+        def costs_required?
+          costs_enabled? && state == "accepted"
+        end
+
+        def publish_answer?
+          current_component.current_settings.publish_answers_immediately?
+        end
+
+        private
+
+        def costs_enabled?
+          current_component.current_settings.answers_with_costs?
+        end
+      end
+    end
+  end
+end