decidim-participatory_documents 0.2.0

data/db/migrate/20230622081831_add_decidim_participatory_documents_box_positions.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class AddDecidimParticipatoryDocumentsBoxPositions < ActiveRecord::Migration[6.0]
+  class Document < ApplicationRecord
+    self.table_name = :decidim_participatory_documents_documents
+    has_many :sections
+    has_many :annotations, through: :sections
+  end
+
+  class Section < ApplicationRecord
+    self.table_name = :decidim_participatory_documents_sections
+    belongs_to :document
+    has_many :annotations
+  end
+
+  class Annotation < ApplicationRecord
+    self.table_name = :decidim_participatory_documents_annotations
+    belongs_to :section
+  end
+
+  # rubocop:disable Rails/SkipsModelValidations:
+  def change
+    add_column :decidim_participatory_documents_annotations, :position, :integer, null: false, default: 0
+    add_index :decidim_participatory_documents_annotations, :position
+    add_column :decidim_participatory_documents_sections, :position, :integer, null: false, default: 0
+    add_index :decidim_participatory_documents_sections, :position
+
+    Section.find_each do |section|
+      section.update_column(:position, section.document.sections.where("id < ?", section.id).count + 1)
+    end
+
+    Annotation.find_each do |annotation|
+      annotation.update_column(:position, annotation.section.document.annotations.where("decidim_participatory_documents_annotations.id < ?", annotation.id).count + 1)
+    end
+  end
+  # rubocop:enable Rails/SkipsModelValidations:
+end

data/decidim-participatory_documents.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "decidim/participatory_documents/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "decidim-participatory_documents"
+  spec.version = Decidim::ParticipatoryDocuments::VERSION
+  spec.authors = ["Ivan Vergés"]
+  spec.email = ["ivan@pokecode.net"]
+
+  spec.summary = "A module for Decidim that facilitates the creation of proposals related to geolocated issues in a city."
+  spec.description = "A module for Decidim that facilitates the creation of proposals related to geolocated issues in a city"
+  spec.license = "AGPL-3.0"
+  spec.homepage = "https://github.com/openpoke/decidim-module-participatory_documents"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "decidim-core", Decidim::ParticipatoryDocuments::COMPAT_DECIDIM_VERSION
+
+  spec.add_development_dependency "decidim-dev", Decidim::ParticipatoryDocuments::COMPAT_DECIDIM_VERSION
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/decidim/participatory_documents/admin.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+    end
+  end
+end

data/lib/decidim/participatory_documents/admin_engine.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    # This is the engine that runs on the public interface of `ParticipatoryDocuments`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::ParticipatoryDocuments::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :documents do
+          collection do
+            get :pdf_viewer
+            get :edit_pdf
+          end
+          member do
+            put :publish
+          end
+          resources :annotations, except: [:show, :new, :edit]
+          resources :sections, except: [:show, :index]
+          resources :suggestions, only: [:index, :show] do
+            resources :valuation_assignments, only: [:destroy]
+            collection do
+              post :publish_answers
+              resource :valuation_assignment, only: [:create, :destroy]
+            end
+
+            member do
+              patch :answer
+            end
+            resources :suggestion_notes, only: [:create, :edit, :update]
+          end
+        end
+
+        root to: "documents#index"
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/participatory_documents/component.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require "decidim/components/namer"
+
+Decidim.register_component(:participatory_documents) do |component|
+  component.engine = Decidim::ParticipatoryDocuments::Engine
+  component.admin_engine = Decidim::ParticipatoryDocuments::AdminEngine
+  component.icon = "media/images/participatory_documents.svg"
+
+  component.on(:before_destroy) do |instance|
+    raise "Can't destroy this component when there are ParticipatoryDocuments" if Decidim::ParticipatoryDocuments::Document.where(component: instance).any?
+  end
+
+  # component.data_portable_entities = ["Decidim::ParticipatoryDocuments::Document"]
+
+  # component.newsletter_participant_entities = ["Decidim::ParticipatoryDocuments::Document"]
+
+  # component.actions = %w(endorse vote create withdraw amend comment vote_comment)
+
+  # component.query_type = "Decidim::ParticipatoryDocuments::ParticipatoryDocumentsType"
+
+  component.permissions_class_name = "Decidim::ParticipatoryDocuments::Permissions"
+
+  component.settings(:global) do |settings|
+    settings.attribute :suggestion_answering_enabled, type: :boolean, default: true
+    settings.attribute :max_suggestion_length, type: :integer, default: Decidim::ParticipatoryDocuments.max_suggestion_length
+    settings.attribute :min_suggestion_length, type: :integer, default: Decidim::ParticipatoryDocuments.min_suggestion_length
+  end
+
+  # component.settings(:step) do |settings|
+  # end
+
+  component.exports :suggestions do |exports|
+    exports.collection do |component_instance|
+      document = Decidim::ParticipatoryDocuments::Document.find_by(component: component_instance)
+      Decidim::ParticipatoryDocuments::Suggestion
+        .where(suggestable: document)
+        .or(Decidim::ParticipatoryDocuments::Suggestion.where(suggestable: document.sections)).order(:id)
+    end
+
+    exports.include_in_open_data = false
+    exports.serializer Decidim::ParticipatoryDocuments::SuggestionSerializer
+  end
+
+  # component.register_resource(:participatory_document) do |resource|
+  #   resource.model_class_name = "Decidim::ParticipatoryDocuments::Document"
+  #   resource.template = "decidim/participatory_documents/documents/linked_participatory_documents"
+  #   resource.card = "decidim/participatory_documents/participatory_document"
+  #   resource.reported_content_cell = "decidim/participatory_documents/reported_content"
+  #   resource.actions = %w(endorse vote amend comment vote_comment)
+  #   resource.searchable = true
+  # end
+
+  # component.register_stat :participatory_documents_count, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
+  # end
+
+  component.seeds do |participatory_space|
+    admin_user = Decidim::User.find_by(
+      organization: participatory_space.organization,
+      email: "admin@example.org"
+    )
+
+    params = {
+      name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :participatory_documents).i18n_name,
+      published_at: Time.current,
+      manifest_name: :participatory_documents,
+      participatory_space: participatory_space
+    }
+
+    component = Decidim.traceability.perform_action!(
+      "publish",
+      Decidim::Component,
+      admin_user,
+      visibility: "all"
+    ) do
+      Decidim::Component.create!(params)
+    end
+
+    params = {
+      component: component,
+      title: Decidim::Faker::Localized.sentence(word_count: 2),
+      description: Decidim::Faker::Localized.sentence(word_count: 20),
+      author: admin_user,
+      file: ActiveStorage::Blob.create_after_upload!(
+        io: File.open(File.join(__dir__, "seeds", "Exampledocument.pdf")),
+        filename: "Exampledocument.pdf",
+        content_type: "application/pdf",
+        metadata: nil
+      ) # Keep after attached_to
+    }
+
+    document = Decidim.traceability.create!(
+      Decidim::ParticipatoryDocuments::Document,
+      admin_user,
+      params,
+      visibility: "all"
+    )
+
+    group1 = Decidim.traceability.create!(
+      Decidim::ParticipatoryDocuments::Section,
+      admin_user,
+      {
+        document: document,
+        title: Decidim::Faker::Localized.sentence(word_count: 2),
+        state: :draft
+      },
+      visibility: "admin-only"
+    )
+    group2 = Decidim.traceability.create!(
+      Decidim::ParticipatoryDocuments::Section,
+      admin_user,
+      {
+        document: document,
+        title: Decidim::Faker::Localized.sentence(word_count: 2),
+        state: :draft
+      },
+      visibility: "admin-only"
+    )
+    group3 = Decidim.traceability.create!(
+      Decidim::ParticipatoryDocuments::Section,
+      admin_user,
+      {
+        document: document,
+        title: Decidim::Faker::Localized.sentence(word_count: 2),
+        state: :draft
+      },
+      visibility: "admin-only"
+    )
+
+    annotations = [
+      {
+        page_number: 1,
+        section: group1,
+        rect: {
+          left: 25.5,
+          top: 22.123,
+          width: 30.1,
+          height: 10.2
+        }
+      },
+      {
+        page_number: 1,
+        section: group2,
+        rect: {
+          left: 5.5,
+          top: 2.123,
+          width: 10.1,
+          height: 10.2
+        }
+      },
+      {
+        page_number: 1,
+        section: group2,
+        rect: {
+          left: 15.5,
+          top: 12.123,
+          width: 10.1,
+          height: 10.2
+        }
+      },
+      {
+        page_number: 1,
+        section: group3,
+        rect: {
+          left: 75.5,
+          top: 82.123,
+          width: 10.1,
+          height: 10.2
+        }
+      },
+      {
+        page_number: 2,
+        section: group3,
+        rect: {
+          left: 15.5,
+          top: 12.123,
+          width: 10.1,
+          height: 10.2
+        }
+      }
+    ]
+    annotations.each do |annotation|
+      Decidim.traceability.create!(
+        Decidim::ParticipatoryDocuments::Annotation,
+        admin_user,
+        annotation,
+        visibility: "admin-only"
+      )
+    end
+
+    [document, group1, group2, group3].each do |suggestable|
+      10.times do
+        Decidim::ParticipatoryDocuments::Suggestion.create(
+          body: Decidim::Faker::Localized.sentence(word_count: 20),
+          suggestable: suggestable,
+          author: admin_user,
+          state: Decidim::ParticipatoryDocuments::Suggestion::POSSIBLE_STATES.sample
+        )
+      end
+    end
+  end
+end

data/lib/decidim/participatory_documents/engine.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    # This is the engine that runs on the public interface of decidim-ParticipatoryDocuments.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::ParticipatoryDocuments
+
+      routes do
+        scope path: "documents/:document_id/sections/:section_id" do
+          resources :suggestions, only: [:index, :create], controller: :section_suggestions, as: :document_section_suggestions
+        end
+        resources :documents do
+          collection do
+            get :pdf_viewer
+          end
+          resources :suggestions, only: [:index, :create], controller: :document_suggestions
+        end
+
+        root to: "documents#index"
+      end
+
+      config.to_prepare do
+        Decidim.participatory_space_manifests.each do |manifest|
+          manifest.model_class_name.constantize.new.user_roles.model.include(Decidim::ParticipatoryDocuments::ParticipatorySpaceUserRoleOverride)
+        end
+      rescue StandardError => e
+        Rails.logger.error("Error while trying to include Decidim::ReportingProposals::ParticipatorySpaceUserRoleOverride: #{e.message}")
+      end
+
+      initializer "decidim_participatory_documents.overrides", after: "decidim.action_controller" do
+        config.to_prepare do
+          Decidim::ParticipatorySpaceRoleConfig::Valuator.include(Decidim::ParticipatoryDocuments::ValuatorOverride)
+        end
+      end
+
+      initializer "decidim_participatory_documents.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::ParticipatoryDocuments::Engine.root}/app/cells")
+      end
+
+      initializer "decidim_participatory_documents.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :participatory_documents_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :participatory_documents).i18n_name }
+    manifest_name { :participatory_documents }
+  end
+
+  factory :participatory_documents_document, class: "Decidim::ParticipatoryDocuments::Document" do
+    title { generate_localized_title }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    component { create(:participatory_documents_component) }
+    author { build(:user, :confirmed, organization: component.organization) }
+    box_color { "#faaaaa" }
+    box_opacity { 20 }
+
+    trait :with_file do
+      file { Decidim::Dev.test_file("Exampledocument.pdf", "application/pdf") }
+    end
+
+    trait :with_sections do
+      after :create do |document|
+        document.sections = create_list(:participatory_documents_section, 2, document: document)
+      end
+    end
+
+    trait :with_annotations do
+      after :create do |document|
+        document.sections = create_list(:participatory_documents_section, 2, :with_annotations, document: document)
+      end
+    end
+
+    trait :with_global_suggestions do
+      after :create do |document|
+        document.suggestions = create_list(:participatory_documents_suggestion, 2, suggestable: document)
+      end
+    end
+
+    trait :with_suggestions do
+      after :create do |document|
+        document.sections = create_list(:participatory_documents_section, 2, :with_suggestions, document: document)
+      end
+    end
+  end
+
+  factory :participatory_documents_section, class: "Decidim::ParticipatoryDocuments::Section" do
+    document { create :participatory_documents_document }
+    title { generate_localized_title }
+
+    trait :with_annotation do
+      after :create do |section|
+        section.annotations = [create(:participatory_documents_annotation, section: section)]
+      end
+    end
+
+    trait :with_annotations do
+      after :create do |section|
+        section.annotations = create_list(:participatory_documents_annotation, 2, section: section)
+      end
+    end
+
+    trait :with_suggestions do
+      after :create do |section|
+        section.annotations = create_list(:participatory_documents_annotation, 2, :with_suggestions, section: section)
+      end
+    end
+  end
+
+  factory :participatory_documents_annotation, class: "Decidim::ParticipatoryDocuments::Annotation" do
+    section { create(:participatory_documents_section) }
+    page_number { 1 }
+    rect do
+      {
+        top: rand(1.0..60.0),
+        left: rand(1.0..100.0),
+        width: rand(1.0..15.0),
+        height: rand(1.0..20.0)
+      }
+    end
+
+    trait :with_suggestions do
+      after :create do |annotation|
+        annotation.suggestions = create_list(:participatory_documents_suggestion, 2, suggestable: annotation)
+      end
+    end
+  end
+
+  factory :participatory_documents_suggestion, class: "Decidim::ParticipatoryDocuments::Suggestion" do
+    suggestable { build(:dummy_resource) }
+    author { build(:user, organization: suggestable.organization) }
+    body { Decidim::Faker::Localized.localized { Faker::Lorem.paragraphs(number: 3).join(" ") } }
+    state { Decidim::ParticipatoryDocuments::Suggestion::POSSIBLE_STATES.sample }
+    answer { {} }
+
+    trait :draft do
+      answered_at { nil }
+      answer_is_published { false }
+    end
+
+    trait :published do
+      answered_at { Time.zone.now }
+      answer_is_published { true }
+    end
+
+    trait :not_answered do
+      state { :not_answered }
+    end
+
+    trait :evaluating do
+      state { :evaluating }
+    end
+
+    trait :withdrawn do
+      state { :withdrawn }
+    end
+
+    trait :rejected do
+      state { :rejected }
+    end
+
+    trait :accepted do
+      state { :accepted }
+    end
+
+    trait :with_answer do
+      answer { generate_localized_title }
+    end
+  end
+
+  factory :suggestion_valuation_assignment, class: "Decidim::ParticipatoryDocuments::ValuationAssignment" do
+    suggestion { build(:participatory_documents_suggestion) }
+    valuator_role do
+      space = suggestion.component.participatory_space
+      organization = space.organization
+      build :participatory_process_user_role, role: :valuator, user: build(:user, organization: organization)
+    end
+  end
+
+  factory :participatory_documents_suggestion_note, class: "Decidim::ParticipatoryDocuments::SuggestionNote" do
+    body { Faker::Lorem.sentences(number: 3).join("\n") }
+    suggestion { build(:participatory_documents_suggestion) }
+    author { build(:user, organization: suggestion.organization) }
+  end
+end

data/lib/decidim/participatory_documents/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    VERSION = "0.2.0"
+    DECIDIM_VERSION = "0.27.3"
+    COMPAT_DECIDIM_VERSION = [">= 0.27.0", "< 0.28"].freeze
+  end
+end

data/lib/decidim/participatory_documents.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This namespace holds the logic of the `decidim-participatory_documents` module.
+  module ParticipatoryDocuments
+    include ActiveSupport::Configurable
+
+    # Public: The maximum length of any text field (body, answers, etc) to export.
+    # Defaults to 50. Set to 0 to export the full text.
+    config_accessor :max_export_text_length do
+      50
+    end
+
+    # Public: The minimum length of a suggestion to be considered valid.
+    config_accessor :min_suggestion_length do
+      5
+    end
+
+    # Public: The maximum length of a suggestion to be considered valid.
+    config_accessor :max_suggestion_length do
+      500
+    end
+  end
+end
+
+require "decidim/participatory_documents/engine"
+require "decidim/participatory_documents/admin"
+require "decidim/participatory_documents/admin_engine"
+require "decidim/participatory_documents/component"

data/lib/tasks/decidim_participatory_documents.rake

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+namespace :decidim_participatory_documents do
+  # Since we cannot install pdf.js as node module, nor we can use it from CDN, We are using the prebuilt version.
+  desc "Copies the pdf.js library from plugin root to designated application folder"
+  task :install_pdf_js do
+    copy_pdfjs_to_application "public"
+  end
+
+  private
+
+  def decidim_participatory_documents_path
+    @decidim_participatory_documents_path ||= Pathname.new(decidim_participatory_documents_gemspec.full_gem_path) if Gem.loaded_specs.has_key?("decidim-participatory_documents")
+  end
+
+  def decidim_participatory_documents_gemspec
+    @decidim_participatory_documents_gemspec ||= Gem.loaded_specs["decidim-participatory_documents"]
+  end
+
+  def copy_pdfjs_to_application(destination_path = origin_path)
+    FileUtils.cp_r(decidim_participatory_documents_path.join("pdfjs"), rails_app_path.join(destination_path))
+  end
+end
+
+Rake::Task["decidim:webpacker:upgrade"].enhance do
+  Rake::Task["decidim_participatory_documents:install_pdf_js"].invoke
+end