decidim-enhanced_textwork 1.0.0

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

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to create a paragraph.
+      class ParagraphBaseForm < Decidim::Form
+        include Decidim::TranslatableAttributes
+        include Decidim::AttachmentAttributes
+        include Decidim::ApplicationHelper
+
+        mimic :paragraph
+
+        attribute :address, String
+        attribute :latitude, Float
+        attribute :longitude, Float
+        attribute :category_id, Integer
+        attribute :scope_id, Integer
+        attribute :attachment, AttachmentForm
+        attribute :position, Integer
+        attribute :created_in_meeting, Boolean
+        attribute :meeting_id, Integer
+        attribute :suggested_hashtags, Array[String]
+
+        attachments_attribute :photos
+
+        validates :address, geocoding: true, if: ->(form) { form.has_address? && !form.geocoded? }
+        validates :category, presence: true, if: ->(form) { form.category_id.present? }
+        validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+        validates :scope_id, scope_belongs_to_component: true, if: ->(form) { form.scope_id.present? }
+        validates :meeting_as_author, presence: true, if: ->(form) { form.created_in_meeting? }
+
+        validate :notify_missing_attachment_if_errored
+
+        delegate :categories, to: :current_component
+
+        def map_model(model)
+          body = translated_attribute(model.body)
+          @suggested_hashtags = Decidim::ContentRenderers::HashtagRenderer.new(body).extra_hashtags.map(&:name).map(&:downcase)
+
+          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_component.scopes.find_by(id: @scope_id) : current_component.scope
+        end
+
+        # Scope identifier
+        #
+        # Returns the scope identifier related to the paragraph
+        def scope_id
+          @scope_id || scope&.id
+        end
+
+        def geocoding_enabled?
+          Decidim::Map.available?(:geocoding) && current_component.settings.geocoding_enabled?
+        end
+
+        def has_address?
+          geocoding_enabled? && address.present?
+        end
+
+        def geocoded?
+          latitude.present? && longitude.present?
+        end
+
+        # Finds the Meetings of the current participatory space
+        def meetings
+          @meetings ||= Decidim.find_resource_manifest(:meetings).try(:resource_scope, current_component)
+                               &.order(title: :asc)
+        end
+
+        # Return the meeting as author
+        def meeting_as_author
+          @meeting_as_author ||= meetings.find_by(id: meeting_id)
+        end
+
+        def author
+          return current_organization unless created_in_meeting?
+
+          meeting_as_author
+        end
+
+        def extra_hashtags
+          @extra_hashtags ||= (component_automatic_hashtags + suggested_hashtags).uniq
+        end
+
+        def suggested_hashtags
+          downcased_suggested_hashtags = Array(@suggested_hashtags&.map(&:downcase)).to_set
+          component_suggested_hashtags.select { |hashtag| downcased_suggested_hashtags.member?(hashtag.downcase) }
+        end
+
+        def suggested_hashtag_checked?(hashtag)
+          suggested_hashtags.member?(hashtag)
+        end
+
+        def component_automatic_hashtags
+          @component_automatic_hashtags ||= ordered_hashtag_list(current_component.current_settings.automatic_hashtags)
+        end
+
+        def component_suggested_hashtags
+          @component_suggested_hashtags ||= ordered_hashtag_list(current_component.current_settings.suggested_hashtags)
+        end
+
+        private
+
+        # This method will add an error to the `attachment` field only if there's
+        # any error in any other field. This is needed because when the form has
+        # an error, the attachment is lost, so we need a way to inform the user of
+        # this problem.
+        def notify_missing_attachment_if_errored
+          errors.add(:attachment, :needs_to_be_reattached) if errors.any? && attachment.present?
+          errors.add(:add_photos, :needs_to_be_reattached) if errors.any? && add_photos.present?
+        end
+
+        def ordered_hashtag_list(string)
+          string.to_s.split.reject(&:blank?).uniq.sort_by(&:parameterize)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to create a paragraph.
+      class ParagraphForm < Decidim::EnhancedTextwork::Admin::ParagraphBaseForm
+        translatable_attribute :title, String do |field, _locale|
+          validates field, length: { in: 15..150 }, if: proc { |resource| resource.send(field).present? }
+        end
+        translatable_attribute :body, String
+
+        validates :title, :body, translatable_presence: true
+
+        validate :notify_missing_attachment_if_errored
+
+        def map_model(model)
+          super(model)
+          presenter = ParagraphPresenter.new(model)
+
+          self.title = presenter.title(all_locales: title.is_a?(Hash))
+          self.body = presenter.body(all_locales: body.is_a?(Hash))
+          self.attachment = if model.documents.first.present?
+                              { file: model.documents.first.file, title: translated_attribute(model.documents.first.title) }
+                            else
+                              {}
+                            end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to create a paragraph.
+      class ParagraphNoteForm < Decidim::Form
+        mimic :paragraph_note
+
+        attribute :body, String
+
+        validates :body, presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A common abstract to be used by the Merge and Split paragraphs forms.
+      class ParagraphsForkForm < Decidim::Form
+        mimic :paragraphs_import
+
+        attribute :target_component_id, Integer
+        attribute :paragraph_ids, Array
+
+        validates :target_component, :paragraphs, :current_component, presence: true
+        validate :same_participatory_space
+        validate :mergeable_to_same_component
+
+        def paragraphs
+          @paragraphs ||= Decidim::EnhancedTextwork::Paragraph.where(component: current_component, id: paragraph_ids).uniq
+        end
+
+        def target_component
+          return current_component if clean_target_component_id == current_component.id
+
+          @target_component ||= current_component.siblings.find_by(id: target_component_id)
+        end
+
+        def same_component?
+          target_component == current_component
+        end
+
+        private
+
+        def errors_set
+          @errors_set ||= Set[]
+        end
+
+        def mergeable_to_same_component
+          return true unless same_component?
+
+          paragraphs.each do |paragraph|
+            errors_set << :not_official unless paragraph.official?
+            errors_set << :supported if paragraph.votes.any? || paragraph.endorsements.any?
+          end
+
+          errors_set.each { |error| errors.add(:base, error) } if errors_set.any?
+        end
+
+        def same_participatory_space
+          return if !target_component || !current_component
+
+          errors.add(:target_component, :invalid) if current_component.participatory_space != target_component.participatory_space
+        end
+
+        # Private: Returns the id of the target component.
+        #
+        # We receive this as ["id"] since it's from a select in a form.
+        def clean_target_component_id
+          target_component_id.first.to_i
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 another component.
+      class ParagraphsImportForm < Decidim::Form
+        mimic :paragraphs_import
+
+        attribute :origin_component_id, Integer
+        attribute :import_paragraphs, Boolean
+        attribute :keep_answers, Boolean
+        attribute :keep_authors, Boolean
+        attribute :states, Array
+        attribute :scope_ids, Array
+
+        validates :origin_component_id, :origin_component, :states, :current_component, presence: true
+        validates :import_paragraphs, allow_nil: false, acceptance: true
+        validate :valid_states
+
+        VALID_STATES = %w(accepted not_answered evaluating rejected withdrawn).freeze
+
+        def states_collection
+          VALID_STATES.map do |state|
+            OpenStruct.new(
+              name: I18n.t(state, scope: "decidim.enhanced_textwork.answers"),
+              value: state
+            )
+          end
+        end
+
+        def states
+          super.reject(&:blank?)
+        end
+
+        def scopes
+          Decidim::Scope.where(organization: current_organization, id: scope_ids)
+        end
+
+        def origin_component
+          @origin_component ||= origin_components.find_by(id: origin_component_id)
+        end
+
+        def origin_components
+          @origin_components ||= current_participatory_space.components.where.not(id: current_component.id).where(manifest_name: :paragraphs)
+        end
+
+        def origin_components_collection
+          origin_components.map do |component|
+            [component.name[I18n.locale.to_s], component.id]
+          end
+        end
+
+        private
+
+        def valid_states
+          return if states.all? do |state|
+            VALID_STATES.include?(state)
+          end
+
+          errors.add(:states, :invalid)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users wants to merge two or more
+      # paragraphs into a new one to another paragraph component in the same space.
+      class ParagraphsMergeForm < ParagraphsForkForm
+        validates :paragraphs, length: { minimum: 2 }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users wants to split two or more
+      # paragraphs into a new one to another paragraph component in the same space.
+      class ParagraphsSplitForm < ParagraphsForkForm
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to create a paragraph
+      # through the participatory texts.
+      class ParticipatoryTextParagraphForm < Admin::ParagraphBaseForm
+        attribute :title, String
+        attribute :body, String
+        validates :title, length: { maximum: 150 }, presence: true
+
+        def map_model(model)
+          self.title = translated_attribute(model.title)
+          self.body = translated_attribute(model.body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      # A form object to be used when admin users want to review a collection of paragraphs
+      # from a participatory text.
+      class PreviewParticipatoryTextForm < Decidim::Form
+        attribute :paragraphs, Array[Decidim::EnhancedTextwork::Admin::ParticipatoryTextParagraphForm]
+
+        def from_models(paragraphs)
+          self.paragraphs = paragraphs.collect do |paragraph|
+            Admin::ParticipatoryTextParagraphForm.from_model(paragraph)
+          end
+        end
+
+        def paragraphs_attributes=(attributes); end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      class ValuationAssignmentForm < Decidim::Form
+        mimic :valuator_role
+
+        attribute :id, Integer
+        attribute :paragraph_ids, Array
+
+        validates :valuator_role, :paragraphs, :current_component, presence: true
+        validate :same_participatory_space
+
+        def paragraphs
+          @paragraphs ||= Decidim::EnhancedTextwork::Paragraph.where(component: current_component, id: paragraph_ids).uniq
+        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/enhanced_textwork/collaborative_draft_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object to be used when public users want to create a Collaborative Draft.
+    class CollaborativeDraftForm < Decidim::EnhancedTextwork::ParagraphForm
+      def map_model(model)
+        super
+
+        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
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object to be used when public users want to create a paragraph.
+    class ParagraphForm < Decidim::EnhancedTextwork::ParagraphWizardCreateStepForm
+      include Decidim::TranslatableAttributes
+      include Decidim::AttachmentAttributes
+
+      mimic :paragraph
+
+      attribute :address, String
+      attribute :latitude, Float
+      attribute :longitude, Float
+      attribute :category_id, Integer
+      attribute :scope_id, Integer
+      attribute :has_address, Boolean
+      attribute :attachment, AttachmentForm
+      attribute :suggested_hashtags, Array[String]
+
+      attachments_attribute :photos
+      attachments_attribute :documents
+
+      validates :address, geocoding: true, if: ->(form) { form.has_address? && !form.geocoded? }
+      validates :address, presence: true, if: ->(form) { form.has_address? }
+      validates :category, presence: true, if: ->(form) { form.category_id.present? }
+      validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+      validates :scope_id, scope_belongs_to_component: true, if: ->(form) { form.scope_id.present? }
+      validate :notify_missing_attachment_if_errored
+
+      delegate :categories, to: :current_component
+
+      def map_model(model)
+        super
+
+        body = translated_attribute(model.body)
+        @suggested_hashtags = Decidim::ContentRenderers::HashtagRenderer.new(body).extra_hashtags.map(&:name).map(&:downcase)
+
+        # The scope attribute is with different key (decidim_scope_id), so it
+        # has to be manually mapped.
+        self.scope_id = model.scope.id if model.scope
+
+        self.has_address = true if model.address.present?
+      end
+
+      # 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 scope_id, uses participatory space scope if missing.
+      #
+      # Returns a Decidim::Scope
+      def scope
+        @scope ||= @scope_id ? current_component.scopes.find_by(id: @scope_id) : current_component.scope
+      end
+
+      # Scope identifier
+      #
+      # Returns the scope identifier related to the paragraph
+      def scope_id
+        @scope_id || scope&.id
+      end
+
+      def geocoding_enabled?
+        Decidim::Map.available?(:geocoding) && current_component.settings.geocoding_enabled?
+      end
+
+      def address
+        return unless has_address
+
+        super
+      end
+
+      def has_address?
+        return unless has_address
+
+        geocoding_enabled? && address.present?
+      end
+
+      def geocoded?
+        latitude.present? && longitude.present?
+      end
+
+      def extra_hashtags
+        @extra_hashtags ||= (component_automatic_hashtags + suggested_hashtags).uniq
+      end
+
+      def suggested_hashtags
+        downcased_suggested_hashtags = Array(@suggested_hashtags&.map(&:downcase)).to_set
+        component_suggested_hashtags.select { |hashtag| downcased_suggested_hashtags.member?(hashtag.downcase) }
+      end
+
+      def suggested_hashtag_checked?(hashtag)
+        suggested_hashtags.member?(hashtag)
+      end
+
+      def component_automatic_hashtags
+        @component_automatic_hashtags ||= ordered_hashtag_list(current_component.current_settings.automatic_hashtags)
+      end
+
+      def component_suggested_hashtags
+        @component_suggested_hashtags ||= ordered_hashtag_list(current_component.current_settings.suggested_hashtags)
+      end
+
+      private
+
+      # This method will add an error to the `add_photos` and/or "add_documents" fields
+      # only if there's any error in any other field. This is needed because when the
+      # form has an error, the attachment is lost, so we need a way to inform the user of
+      # this problem.
+      def notify_missing_attachment_if_errored
+        if errors.any?
+          errors.add(:add_photos, :needs_to_be_reattached) if add_photos.present?
+          errors.add(:add_documents, :needs_to_be_reattached) if add_documents.present?
+        end
+      end
+
+      def ordered_hashtag_list(string)
+        string.to_s.split.reject(&:blank?).uniq.sort_by(&:parameterize)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object to be used when public users want to create a paragraph.
+    class ParagraphWizardCreateStepForm < Decidim::Form
+      mimic :paragraph
+
+      attribute :title, String
+      attribute :body, Decidim::Attributes::CleanString
+      attribute :body_template, String
+      attribute :user_group_id, Integer
+
+      validates :title, :body, presence: true, etiquette: true
+      validates :title, length: { in: 15..150 }
+      validates :body, paragraph_length: {
+        minimum: 15,
+        maximum: ->(record) { record.component.settings.paragraph_length }
+      }
+
+      validate :body_is_not_bare_template
+
+      alias component current_component
+
+      def map_model(model)
+        self.user_group_id = model.user_groups.first&.id
+        return unless model.categorization
+
+        self.category_id = model.categorization.decidim_category_id
+      end
+
+      private
+
+      def body_is_not_bare_template
+        return if body_template.blank?
+
+        errors.add(:body, :cant_be_equal_to_template) if body.presence == body_template.presence
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A form object to be used when Collaborative Draft editors rejects a request to acces it.
+    class RejectAccessToCollaborativeDraftForm < AccessToCollaborativeDraftForm
+    end
+  end
+end

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

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

data/app/helpers/decidim/enhanced_textwork/admin/filterable_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module Admin
+      module FilterableHelper
+        def extra_dropdown_submenu_options_items(filter, i18n_scope)
+          options = case filter
+                    when :state_eq
+                      tag.li(filter_link_value(:state_null, true, i18n_scope))
+                    end
+          [options].compact
+        end
+      end
+    end
+  end
+end