Decidim Participatory Documents

This module allows to upload PDF (and possibilty other formats) and define areas on top of it that will become spaces for suggestions, improvements and other participative activities.

Installation

Add this line to your application's Gemfile:

gem 'decidim-participatory_documents

Or, if you want to stay up to date with the latest changes use this line instead:

gem 'decidim-participatory_documents', git: "https://github.com/openpoke/decidim-module-participatory-documents"

And then execute:

bundle
bin/rails decidim:upgrade
bundle exec rails db:migrate

NOTE Under the hood, these operation are run to install the needed database migrations and the PDF.js library:

bundle
bundle exec rails decidim_participatory_documents:install:migrations
bundle exec rails decidim_participatory_documents:install_pdf_js

Note that the PDF.js library is installed in the public/pdfjs (this might change in the future). Take it into account when deploying the application.

Depending on your Decidim version, you can choose the corresponding version to ensure compatibility:

Version	Compatible Decidim versions
0.2.x	0.27.x
0.3.x	0.28.x
0.4.x	0.29.x

Required MIME types

Latests versions of PDFjs require that the web server to send the mime type text/javascript for files ending in .mjs

Usage with Puma + Rack

If you are using Puma with Rack (< v3.1.0) you might have to add and initializer to ensure files with .mjs are served correctly. This is usually the most common approach when docker is used or when the ENV var RAILS_SERVE_STATIC_FILES=true is active.

Execute the following command to create an initializer that does that:

bin/rails decidim_participatory_documents:install_mjs_initializer

Usage with external static file servers

A common setup is to use standalone web server (such as Nginx or Apache) to serve the static files present in the public folder. If that is your case, you need to ensure that the files ending with the extension .mjs are served with the mime type text/javascript.

For Apache webserver

Make sure to add AddType text/javascript .mjs in the mime_module:

<IfModule mime_module>
...
  AddType text/javascript .mjs
</IfModule>

or in a .htaccess file:

<IfModule mod_mime.c>
  AddType text/javascript mjs
</IfModule>

For Nginx webserver

Edit the file /etc/nginx/mime.types and add the type (if missing):

types {
  ...
  text/javascript mjs;
}

Usage

This module adds a new component to Decidim called Participatory Documents that allows to upload PDFs and define areas on top of it that will become spaces for suggestions or comments.

The administrator must upload a PDF file and then define areas on top of it by drawing polygons. Each area will become a new zone that will allow users to create suggestions.

Configuration

By default, the module is configured to read the configuration from ENV variables.

Currently, the following ENV variables are supported:

ENV variable	Description	Default value
MAX_EXPORT_TEXT_LENGTH	If a positive number, it will truncate the exported suggestions before sending them by email	0
MIN_SUGGESTION_LENGTH	Minimum characters in a suggestion to be valid (this setting can be configured in each component as well by the admins)	5
MAX_SUGGESTION_LENGTH	Maximum characters in a suggestion to be valid (this setting can be configured in each component as well by the admins)	1000

It is also possible to configure the module using the decidim-participatory_documents initializer:

Decidim::ParticipatoryDocuments.configure do |config|
  config.max_export_text_length = 0
  config.min_suggestion_length = 5
  config.max_suggestion_length = 1000
end

Antivirus compatibility

This module has a builtin compatibility with https://github.com/mainio/decidim-module-antivirus to scan the uploaded documents (it is also possible to directly use the gem https://github.com/mainio/ratonvirus if configuring it in a initializer).

If the antivirus is not installed, the module will still work but the documents will not be scanned.

Note: this module only checks for the existence of the class AntivirusValidator so it is possible to use any other antivirus validator as well (a custom one for instance).

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/openpoke/decidim-module-participatory-documents.

Developing

To start contributing to this project, first:

• Install the basic dependencies (such as Ruby and PostgreSQL)
• Clone this repository

Decidim's main repository also provides a Docker configuration file if you prefer to use Docker instead of installing the dependencies locally on your machine.

You can create the development app by running the following commands after cloning this project:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

Then to test how the module works in Decidim, start the development server:

$ cd development_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add the environment variables to the root directory of the project in a file named .rbenv-vars. If these are defined for the environment, you can omit defining these in the commands shown above.

Code Styling

Please follow the code styling defined by the different linters that ensure we are all talking with the same language collaborating on the same project. This project is set to follow the same rules that Decidim itself follows.

Rubocop linter is used for the Ruby language.

You can run the code styling checks by running the following commands from the console:

$ bundle exec rubocop

To ease up following the style guide, you should install the plugin to your favorite editor, such as:

• Atom - linter-rubocop
• Sublime Text - Sublime RuboCop
• Visual Studio Code - Rubocop for Visual Studio Code

Testing

To run the tests run the following in the gem development path:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add these environment variables to the root directory of the project in a file named .rbenv-vars. In this case, you can omit defining these in the commands shown above.

Test code coverage

If you want to generate the code coverage report for the tests, you can use the SIMPLECOV=1 environment variable in the rspec command as follows:

$ SIMPLECOV=1 bundle exec rspec

This will generate a folder named coverage in the project root which contains the code coverage report.

Localization

If you would like to see this module in your own language, you can help with its translation at Crowdin:

https://crowdin.com/project/decidim-participatory-documents

License

See LICENSE-AGPLv3.txt.