decidim-enhanced_textwork 1.0.0

data/lib/decidim/enhanced_textwork/test/factories.rb

@@ -0,0 +1,492 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+require "decidim/participatory_processes/test/factories"
+require "decidim/meetings/test/factories"
+
+FactoryBot.define do
+  factory :paragraph_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :paragraphs).i18n_name }
+    manifest_name { :paragraphs }
+    participatory_space { create(:participatory_process, :with_steps, organization: organization) }
+
+    trait :with_endorsements_enabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => { endorsements_enabled: true }
+        }
+      end
+    end
+
+    trait :with_endorsements_disabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => { endorsements_enabled: false }
+        }
+      end
+    end
+
+    trait :with_votes_enabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => { votes_enabled: true }
+        }
+      end
+    end
+
+    trait :with_votes_disabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => { votes_enabled: false }
+        }
+      end
+    end
+
+    trait :with_votes_hidden do
+      step_settings do
+        {
+          participatory_space.active_step.id => { votes_hidden: true }
+        }
+      end
+    end
+
+    trait :with_vote_limit do
+      transient do
+        vote_limit { 10 }
+      end
+
+      settings do
+        {
+          vote_limit: vote_limit
+        }
+      end
+    end
+
+    trait :with_paragraph_limit do
+      transient do
+        paragraph_limit { 1 }
+      end
+
+      settings do
+        {
+          paragraph_limit: paragraph_limit
+        }
+      end
+    end
+
+    trait :with_paragraph_length do
+      transient do
+        paragraph_length { 500 }
+      end
+
+      settings do
+        {
+          paragraph_length: paragraph_length
+        }
+      end
+    end
+
+    trait :with_endorsements_blocked do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            endorsements_enabled: true,
+            endorsements_blocked: true
+          }
+        }
+      end
+    end
+
+    trait :with_votes_blocked do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            votes_enabled: true,
+            votes_blocked: true
+          }
+        }
+      end
+    end
+
+    trait :with_creation_enabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => { creation_enabled: true }
+        }
+      end
+    end
+
+    trait :with_geocoding_enabled do
+      settings do
+        {
+          geocoding_enabled: true
+        }
+      end
+    end
+
+    trait :with_attachments_allowed do
+      settings do
+        {
+          attachments_allowed: true
+        }
+      end
+    end
+
+    trait :with_threshold_per_paragraph do
+      transient do
+        threshold_per_paragraph { 1 }
+      end
+
+      settings do
+        {
+          threshold_per_paragraph: threshold_per_paragraph
+        }
+      end
+    end
+
+    trait :with_can_accumulate_supports_beyond_threshold do
+      settings do
+        {
+          can_accumulate_supports_beyond_threshold: true
+        }
+      end
+    end
+
+    trait :with_collaborative_drafts_enabled do
+      settings do
+        {
+          collaborative_drafts_enabled: true
+        }
+      end
+    end
+
+    trait :with_attachments_allowed_and_collaborative_drafts_enabled do
+      settings do
+        {
+          attachments_allowed: true,
+          collaborative_drafts_enabled: true
+        }
+      end
+    end
+
+    trait :with_minimum_votes_per_user do
+      transient do
+        minimum_votes_per_user { 3 }
+      end
+
+      settings do
+        {
+          minimum_votes_per_user: minimum_votes_per_user
+        }
+      end
+    end
+
+    trait :with_participatory_texts_enabled do
+      settings do
+        {
+          participatory_texts_enabled: true
+        }
+      end
+    end
+
+    trait :with_amendments_enabled do
+      settings do
+        {
+          amendments_enabled: true
+        }
+      end
+    end
+
+    trait :with_amendments_and_participatory_texts_enabled do
+      settings do
+        {
+          participatory_texts_enabled: true,
+          amendments_enabled: true
+        }
+      end
+    end
+
+    trait :with_comments_disabled do
+      settings do
+        {
+          comments_enabled: false
+        }
+      end
+    end
+
+    trait :with_extra_hashtags do
+      transient do
+        automatic_hashtags { "AutoHashtag AnotherAutoHashtag" }
+        suggested_hashtags { "SuggestedHashtag AnotherSuggestedHashtag" }
+      end
+
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            automatic_hashtags: automatic_hashtags,
+            suggested_hashtags: suggested_hashtags,
+            creation_enabled: true
+          }
+        }
+      end
+    end
+
+    trait :without_publish_answers_immediately do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            publish_answers_immediately: false
+          }
+        }
+      end
+    end
+  end
+
+  factory :paragraph, class: "Decidim::EnhancedTextwork::Paragraph" do
+    transient do
+      users { nil }
+      # user_groups correspondence to users is by sorting order
+      user_groups { [] }
+      skip_injection { false }
+    end
+
+    title do
+      if skip_injection
+        Decidim::Faker::Localized.localized { generate(:title) }
+      else
+        Decidim::Faker::Localized.localized { "<script>alert(\"TITLE\");</script> #{generate(:title)}" }
+      end
+    end
+    body do
+      if skip_injection
+        Decidim::Faker::Localized.localized { Faker::Lorem.sentences(number: 3).join("\n") }
+      else
+        Decidim::Faker::Localized.localized { "<script>alert(\"TITLE\");</script> #{Faker::Lorem.sentences(number: 3).join("\n")}" }
+      end
+    end
+    component { create(:paragraph_component) }
+    published_at { Time.current }
+    address { "#{Faker::Address.street_name}, #{Faker::Address.city}" }
+    latitude { Faker::Address.latitude }
+    longitude { Faker::Address.longitude }
+    cost { 20_000 }
+    cost_report { { en: "My cost report" } }
+    execution_period { { en: "My execution period" } }
+
+    after(:build) do |paragraph, evaluator|
+      paragraph.title = if evaluator.title.is_a?(String)
+                         { paragraph.try(:organization).try(:default_locale) || "en" => evaluator.title }
+                       else
+                         evaluator.title
+                       end
+      paragraph.body = if evaluator.body.is_a?(String)
+                        { paragraph.try(:organization).try(:default_locale) || "en" => evaluator.body }
+                      else
+                        evaluator.body
+                      end
+
+      paragraph.title = Decidim::ContentProcessor.parse_with_processor(:hashtag, paragraph.title, current_organization: paragraph.organization).rewrite
+      paragraph.body = Decidim::ContentProcessor.parse_with_processor(:hashtag, paragraph.body, current_organization: paragraph.organization).rewrite
+
+      if paragraph.component
+        users = evaluator.users || [create(:user, :confirmed, organization: paragraph.component.participatory_space.organization)]
+        users.each_with_index do |user, idx|
+          user_group = evaluator.user_groups[idx]
+          paragraph.coauthorships.build(author: user, user_group: user_group)
+        end
+      end
+    end
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :unpublished do
+      published_at { nil }
+    end
+
+    trait :citizen_author do
+      after :build do |paragraph|
+        paragraph.coauthorships.clear
+        user = build(:user, organization: paragraph.component.participatory_space.organization)
+        paragraph.coauthorships.build(author: user)
+      end
+    end
+
+    trait :user_group_author do
+      after :build do |paragraph|
+        paragraph.coauthorships.clear
+        user = create(:user, organization: paragraph.component.participatory_space.organization)
+        user_group = create(:user_group, :verified, organization: user.organization, users: [user])
+        paragraph.coauthorships.build(author: user, user_group: user_group)
+      end
+    end
+
+    trait :official do
+      after :build do |paragraph|
+        paragraph.coauthorships.clear
+        paragraph.coauthorships.build(author: paragraph.organization)
+      end
+    end
+
+    trait :official_meeting do
+      after :build do |paragraph|
+        paragraph.coauthorships.clear
+        component = build(:meeting_component, participatory_space: paragraph.component.participatory_space)
+        paragraph.coauthorships.build(author: build(:meeting, component: component))
+      end
+    end
+
+    trait :evaluating do
+      state { "evaluating" }
+      answered_at { Time.current }
+      state_published_at { Time.current }
+    end
+
+    trait :accepted do
+      state { "accepted" }
+      answered_at { Time.current }
+      state_published_at { Time.current }
+    end
+
+    trait :rejected do
+      state { "rejected" }
+      answered_at { Time.current }
+      state_published_at { Time.current }
+    end
+
+    trait :withdrawn do
+      state { "withdrawn" }
+    end
+
+    trait :accepted_not_published do
+      state { "accepted" }
+      answered_at { Time.current }
+      state_published_at { nil }
+      answer { generate_localized_title }
+    end
+
+    trait :with_answer do
+      state { "accepted" }
+      answer { generate_localized_title }
+      answered_at { Time.current }
+      state_published_at { Time.current }
+    end
+
+    trait :not_answered do
+      state { nil }
+    end
+
+    trait :draft do
+      published_at { nil }
+    end
+
+    trait :hidden do
+      after :create do |paragraph|
+        create(:moderation, hidden_at: Time.current, reportable: paragraph)
+      end
+    end
+
+    trait :with_votes do
+      after :create do |paragraph|
+        create_list(:paragraph_vote, 5, paragraph: paragraph)
+      end
+    end
+
+    trait :with_endorsements do
+      after :create do |paragraph|
+        5.times.collect do
+          create(:endorsement, resource: paragraph, author: build(:user, organization: paragraph.participatory_space.organization))
+        end
+      end
+    end
+
+    trait :with_amendments do
+      after :create do |paragraph|
+        create_list(:paragraph_amendment, 5, amendable: paragraph)
+      end
+    end
+
+    trait :with_photo do
+      after :create do |paragraph|
+        paragraph.attachments << create(:attachment, :with_image, attached_to: paragraph)
+      end
+    end
+
+    trait :with_document do
+      after :create do |paragraph|
+        paragraph.attachments << create(:attachment, :with_pdf, attached_to: paragraph)
+      end
+    end
+  end
+
+  factory :paragraph_vote, class: "Decidim::EnhancedTextwork::ParagraphVote" do
+    paragraph { build(:paragraph) }
+    author { build(:user, organization: paragraph.organization) }
+  end
+
+  factory :paragraph_amendment, class: "Decidim::Amendment" do
+    amendable { build(:paragraph) }
+    emendation { build(:paragraph, component: amendable.component) }
+    amender { build(:user, organization: amendable.component.participatory_space.organization) }
+    state { Decidim::Amendment::STATES.sample }
+  end
+
+  factory :paragraph_note, class: "Decidim::EnhancedTextwork::ParagraphNote" do
+    body { Faker::Lorem.sentences(number: 3).join("\n") }
+    paragraph { build(:paragraph) }
+    author { build(:user, organization: paragraph.organization) }
+  end
+
+  factory :collaborative_draft, class: "Decidim::EnhancedTextwork::CollaborativeDraft" do
+    transient do
+      users { nil }
+      # user_groups correspondence to users is by sorting order
+      user_groups { [] }
+    end
+
+    title { "<script>alert(\"TITLE\");</script> #{generate(:title)}" }
+    body { "<script>alert(\"BODY\");</script>\n#{Faker::Lorem.sentences(number: 3).join("\n")}" }
+    component { create(:paragraph_component) }
+    address { "#{Faker::Address.street_name}, #{Faker::Address.city}" }
+    state { "open" }
+
+    after(:build) do |collaborative_draft, evaluator|
+      if collaborative_draft.component
+        users = evaluator.users || [create(:user, organization: collaborative_draft.component.participatory_space.organization)]
+        users.each_with_index do |user, idx|
+          user_group = evaluator.user_groups[idx]
+          collaborative_draft.coauthorships.build(author: user, user_group: user_group)
+        end
+      end
+    end
+
+    trait :published do
+      state { "published" }
+      published_at { Time.current }
+    end
+
+    trait :open do
+      state { "open" }
+    end
+
+    trait :withdrawn do
+      state { "withdrawn" }
+    end
+  end
+
+  factory :participatory_text, class: "Decidim::EnhancedTextwork::ParticipatoryText" do
+    title { { en: "<script>alert(\"TITLE\");</script> #{generate(:title)}" } }
+    description { { en: "<script>alert(\"DESCRIPTION\");</script>\n#{Faker::Lorem.sentences(number: 3).join("\n")}" } }
+    component { create(:paragraph_component) }
+  end
+
+  factory :valuation_assignment, class: "Decidim::EnhancedTextwork::ValuationAssignment" do
+    paragraph
+    valuator_role do
+      space = paragraph.component.participatory_space
+      organization = space.organization
+      build :participatory_process_user_role, role: :valuator, user: build(:user, organization: organization)
+    end
+  end
+end

data/lib/decidim/enhanced_textwork/valuatable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    # A set of methods and features related to paragraph valuations.
+    module Valuatable
+      extend ActiveSupport::Concern
+      include Decidim::Comments::Commentable
+
+      included do
+        has_many :valuation_assignments, foreign_key: "decidim_paragraph_id", dependent: :destroy
+
+        def valuators
+          valuator_role_ids = valuation_assignments.where(paragraph: self).pluck(:valuator_role_id)
+          user_ids = participatory_space.user_roles(:valuator).where(id: valuator_role_ids).pluck(:decidim_user_id)
+          participatory_space.organization.users.where(id: user_ids)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/enhanced_textwork/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds decidim-paragraphs version.
+  module EnhancedTextwork
+    def self.version
+      "1.0.0"
+    end
+
+    def self.compat_decidim_version 
+      [">= 0.25", "<=0.26"].freeze
+    end
+  end
+end

data/lib/decidim/enhanced_textwork.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "decidim/enhanced_textwork/admin"
+require "decidim/enhanced_textwork/api"
+require "decidim/enhanced_textwork/engine"
+require "decidim/enhanced_textwork/admin_engine"
+require "decidim/enhanced_textwork/component"
+
+module Decidim
+  # This namespace holds the logic of the `Paragraphs` component. This component
+  # allows users to create paragraphs in a participatory process.
+  module EnhancedTextwork
+    autoload :ParagraphSerializer, "decidim/enhanced_textwork/paragraph_serializer"
+    autoload :ParagraphCreator, "decidim/enhanced_textwork/paragraph_creator"
+    autoload :CommentableParagraph, "decidim/enhanced_textwork/commentable_paragraph"
+    autoload :CommentableCollaborativeDraft, "decidim/enhanced_textwork/commentable_collaborative_draft"
+    autoload :MarkdownToParagraphs, "decidim/enhanced_textwork/markdown_to_paragraphs"
+    autoload :ParticipatoryTextSection, "decidim/enhanced_textwork/participatory_text_section"
+    autoload :DocToMarkdown, "decidim/enhanced_textwork/doc_to_markdown"
+    autoload :OdtToMarkdown, "decidim/enhanced_textwork/odt_to_markdown"
+    autoload :HtmlToMarkdown, "decidim/enhanced_textwork/html_to_markdown"
+    autoload :Valuatable, "decidim/enhanced_textwork/valuatable"
+
+    include ActiveSupport::Configurable
+
+    # Public Setting that defines the similarity minimum value to consider two
+    # paragraphs similar. Defaults to 0.25.
+    config_accessor :similarity_threshold do
+      0.25
+    end
+
+    # Public Setting that defines how many similar paragraphs will be shown.
+    # Defaults to 10.
+    config_accessor :similarity_limit do
+      10
+    end
+
+    # Public Setting that defines how many paragraphs will be shown in the
+    # participatory_space_highlighted_elements view hook
+    config_accessor :participatory_space_highlighted_paragraphs_limit do
+      4
+    end
+
+    # Public Setting that defines how many paragraphs will be shown in the
+    # process_group_highlighted_elements view hook
+    config_accessor :process_group_highlighted_paragraphs_limit do
+      3
+    end
+  end
+
+  module ContentParsers
+    autoload :ParagraphParser, "decidim/content_parsers/paragraph_parser"
+  end
+
+  module ContentRenderers
+    autoload :ParagraphRenderer, "decidim/content_renderers/paragraph_renderer"
+  end
+end