decidim 0.30.2 → 0.31.0.rc1

data/docs/modules/install/pages/manual.adoc

@@ -4,8 +4,8 @@ In order to develop on decidim, you will need:
 
 * *Git* 2.34+
 * *PostgreSQL* 17.4+
-* *Ruby* 3.1.1
-* *NodeJS* 18.17.x
+* *Ruby* 3.3.0
+* *NodeJS* 22.14.x
 * *Npm* 10.9.x
 * *ImageMagick*
 * *Chrome* browser and https://sites.google.com/a/chromium.org/chromedriver/[chromedriver] (if you need to run specs/tests)
@@ -33,8 +33,8 @@ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
 echo 'eval "$(rbenv init -)"' >> ~/.bashrc
 source ~/.bashrc
 git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
-rbenv install 3.1.1
-rbenv global 3.1.1
+rbenv install 3.3.0
+rbenv global 3.3.0
 ----
 
 == 2. Installing PostgreSQL
@@ -57,7 +57,7 @@ An important component for Decidim is Node.js and Yarn. With this commands you w
 ----
 curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
 source "$HOME/.nvm/nvm.sh"
-nvm install 18
+nvm install 24
 npm install -g yarn
 ----
 

data/docs/modules/install/partials/version_matrix.adoc

@@ -2,11 +2,13 @@
 |===
 |Decidim version |Ruby version |Node version | Status
 
-|develop | 3.3.4 | 18.17.x | Unreleased
+|develop | 3.3.4 | 22.14.x | Unreleased
+
+|v0.30 | 3.3.4 | 18.17.x | Bug fixes and security updates
 
 |v0.29 | 3.2.2 | 18.17.x | Bug fixes and security updates
 
-|v0.28 | 3.1.1 | 18.17.x | Bug fixes and security updates
+|v0.28 | 3.1.1 | 18.17.x | Not maintained
 
 |v0.27 | 3.0.2 | 16.18.x | Security updates
 

data/docs/modules/services/pages/aitools.adoc

@@ -72,7 +72,6 @@ Decidim::Ai::SpamDetection.resource_models = {
   "Decidim::Meetings::Meeting" => "Decidim::Ai::SpamDetection::Resource::Meeting",
   "Decidim::Proposals::Proposal" => "Decidim::Ai::SpamDetection::Resource::Proposal",
   "Decidim::Proposals::CollaborativeDraft" => "Decidim::Ai::SpamDetection::Resource::CollaborativeDraft",
-  "Decidim::UserGroup" => "Decidim::Ai::SpamDetection::Resource::UserBaseEntity",
   "Decidim::User" => "Decidim::Ai::SpamDetection::Resource::UserBaseEntity"
 }
 
@@ -110,7 +109,6 @@ Decidim::Ai::SpamDetection.user_analyzers = [
 # override what we register by default, or to register your own resources.
 # Follow the documentation on how to trail more resources
 Decidim::Ai::SpamDetection.user_models = {
-  "Decidim::UserGroup" => "Decidim::Ai::SpamDetection::Resource::UserBaseEntity",
   "Decidim::User" => "Decidim::Ai::SpamDetection::Resource::UserBaseEntity"
 }
 

data/docs/modules/services/pages/etherpad.adoc

@@ -18,28 +18,13 @@ docker swarm init # just one time
 docker stack deploy --compose-file docker-compose-etherpad.yml decidim-etherpad
 ----
 
-After deploying Etherpad, you should get back to Decidim's server and set the Etherpad host and API Key at
-`config/initializers/decidim.rb` and `config/secrets.yml`
+After deploying Etherpad, you should get back to Decidim's server and set the Etherpad host and API Key using the xref:configure:environment_variables.adoc[environment variables].
 
-An example snippet in `config/initializers/decidim.rb` may be:
-
-[source,ruby]
-----
-config.etherpad = {
-  server: Rails.application.secrets.etherpad[:server],
-  api_key: Rails.application.secrets.etherpad[:api_key],
-  api_version: Rails.application.secrets.etherpad[:api_version]
-}
-----
-
-and then in `config/secrets.yml`:
-
-[source,yaml]
+[source,console]
 ----
-  etherpad:
-    server: <%= ENV["ETHERPAD_SERVER"] %>
-    api_key: <%= ENV["ETHERPAD_API_KEY"] %>
-    api_version: <%= ENV["ETHERPAD_API_VERSION"] %>
+export ETHERPAD_SERVER=...
+export ETHERPAD_API_KEY=....
+export ETHERPAD_API_VERSION=...
 ----
 
 == How is Etherpad Lite integrated in Meetings?

data/docs/modules/services/pages/machine_translation.adoc

@@ -0,0 +1,38 @@
+= Machine Translations
+
+To enable machine translations you need to enable the service and specify the class used for translation (this usually is the one contacting an external API from a 3d party service that actually translates the string).
+
+[source,ruby]
+....
+class MyTranslationService
+  attr_reader :text, :source_locale, :target_locale, :resource, :field_name
+
+  def initialize(resource, field_name, text, target_locale, source_locale)
+    @resource = resource
+    @field_name = field_name
+    @text = text
+    @target_locale = target_locale
+    @source_locale = source_locale
+  end
+
+  def translate
+    # Actual code to translate the text
+  end
+end
+....
+
+The arguments provided for the initialize method are:
+
+- `resource` - The object of the resource that being translated (ex: a `Decidim::Meetings::Meeting` instance )
+- `field_name` - The name of the field that is being translated (ex: "title")
+- `text` - The text that is going to be translated (ex: "This meeting is great" )
+- `target_locale` - The language in which you want to translate ( ex: "ca" )
+- `source_locale` - The language in which the content has been created (ex: "en")
+
+Then you will need to configure it with the help of Environment Variables:
+
+[source,bash]
+....
+export DECIDIM_ENABLE_MACHINE_TRANSLATION="true"
+export DECIDIM_MACHINE_TRANSLATION_SERVICE="MyTranslator"
+....

data/docs/modules/services/pages/maps.adoc

@@ -26,56 +26,20 @@ If you want to integrate Decidim to some other map service provider, read how to
 
 == Configuring maps and geocoding
 
-After generating your app, you will see that your `config/initializers/decidim.rb` file includes commented code about map services:
+After generating your app, you will need to configure the maps service by setting your environment variables.
 
-[source,ruby]
-----
-# Map and Geocoder configuration
-# config.maps = {
-#   ...
-# }
-----
-
-The initializer comments provide examples for the services mentioned in this documentation.
 Please refer to the section below for the service you have registered for the maps functionality.
 
 If you want to enable geocoding in your app:
 
 . Select a service provider for the maps functionality and register an account with that provider
-. Uncomment or add the code under the selected service provider in your `config/initializers/decidim.rb`.
-. Make sure your `config/secrets.yml` file has the needed section (it should be added by the generator automatically).
-. Configure the service provider credentials in `config/secrets.yml` and refer to them from your `config/initializers/decidim.rb`.
+. Set the `MAPS_GEOCODING_HOST` environment variable, or, if the setup is more complex, customize using the initializer.
 . If you had your Rails server running, restart it so the changes apply.
 
 === Configuring HERE Maps
 
 Use the following configuration for HERE Maps:
 
-`config/initializers/decidim.rb`:
-
-[source,ruby]
-----
-# Map and Geocoder configuration
-# == HERE Maps ==
-config.maps = {
-  provider: :here,
-  api_key: Rails.application.secrets.maps[:api_key],
-  static: { url: "https://image.maps.hereapi.com/mia/v3/base/mc/overlay" }
-}
-----
-
-`config/secrets.yml`:
-
-[source,yaml]
-----
-default: &default
-  # ...
-  maps:
-    api_key: <%= ENV["MAPS_API_KEY"] %>
-----
-
-`.env`:
-
 [source,bash]
 ----
 MAPS_PROVIDER=here
@@ -84,9 +48,7 @@ MAPS_API_KEY=your_api_key_here
 
 === Configuring Open Street Maps based service providers
 
-Use the following configuration for Open Street Maps based service providers:
-
-`config/initializers/decidim.rb`:
+Use the following configuration for Open Street Maps based service providers, by creating your xref:configure:initializer.adoc[initializer]:
 
 [source,ruby]
 ----
@@ -94,7 +56,7 @@ Use the following configuration for Open Street Maps based service providers:
 # == OpenStreetMap (OSM) services ==
 config.maps = {
   provider: :osm,
-  api_key: Rails.application.secrets.maps[:api_key],
+  api_key: ENV["MAPS_API_KEY"],
   dynamic: {
     tile_layer: {
       url: "https://tiles.example.org/{z}/{x}/{y}.png?key={apiKey}",
@@ -112,16 +74,6 @@ config.maps = {
 }
 ----
 
-`config/secrets.yml`:
-
-[source,yaml]
-----
-default: &default
-  # ...
-  maps:
-    api_key: <%= ENV["MAPS_API_KEY"] %>
-----
-
 `.env`:
 
 [source,bash]
@@ -134,7 +86,7 @@ For further information, see the service provider's documentation or take a look
 === Combining multiple service providers
 
 It is also possible to combine multiple service providers for the different categories of map services.
-For instance, if you want to use HERE Maps for the map tiles but host the other services yourself, use the following configuration:
+For instance, if you want to use HERE Maps for the map tiles but host the other services yourself, use the following configuration, that can be added only in an initializer:
 
 [source,ruby]
 ----
@@ -144,7 +96,7 @@ config.maps = {
   provider: :osm,
   dynamic: {
     provider: :here,
-    api_key: Rails.application.secrets.maps[:here_api_key]
+    api_key: ENV["MAPS_API_KEY"]
   },
   static: { url: "https://staticmap.example.org/" },
   geocoding: { host: "nominatim.example.org", use_https: true },
@@ -152,16 +104,6 @@ config.maps = {
 }
 ----
 
-`config/secrets.yml`:
-
-[source,yaml]
-----
-default: &default
-  # ...
-  maps:
-    here_api_key: <%= ENV["MAPS_HERE_API_KEY"] %>
-----
-
 `.env`:
 
 [source,bash]
@@ -181,7 +123,7 @@ For example, if you want to use HERE Maps as your default but disable the static
 ----
 config.maps = {
   provider: :here,
-  api_key: Rails.application.secrets.maps[:api_key],
+  api_key: ENV["MAPS_API_KEY"],
   static: false,
   autocomplete: false
 }
@@ -191,7 +133,7 @@ Decidim works fine when some of the services are disabled individually but obvio
 
 === Global geocoder configurations
 
-In the Decidim initialiser (`config/initializers/decidim.rb`) you will also see a commented section for the global geocoder configurations commented as follows:
+In order to fully customize the geocoding service, you may need to create the xref:configure:initializer.adoc[initializer] file, and customize your config as follows:
 
 [source,ruby]
 ----

data/docs/modules/services/pages/pdf.adoc

@@ -0,0 +1,33 @@
+= PDF signature service
+
+Used by `decidim-initiatives` and `decidim-budgets`.
+
+Provide a class to process a pdf and return the document including a digital signature. The instances of this class are initialized with a hash containing the :pdf key with the pdf file content as value. The instances respond to a signed_pdf method containing the pdf with the signature.
+
+An example class would be something like:
+
+[source,ruby]
+....
+class MyPDFSignatureService
+  attr_accessor :pdf
+
+  def initialize(args = {})
+    @pdf = args.fetch(:pdf)
+  end
+
+  def signed_pdf
+    # Code to return the pdf signed
+  end
+end
+....
+
+The arguments provided for the initialize method are:
+
+- `pdf` - The document that needs to be signed
+
+Then you will need to configure it with the help of Environment Variables:
+
+[source,bash]
+....
+export DECIDIM_PDF_SIGNATURE_SERVICE="PdfSignatureExample"
+....

data/docs/modules/services/pages/sms.adoc

@@ -1,8 +1,7 @@
-= SMS
+= SMS gateway configuration
 
-If you want to verify your users by sending a verification code via SMS you need to provide a SMS gateway service class through the xref:configure:initializer.adoc[initializer].
-
-This service can also be used by some spaces, and external modules could use it too.
+If you want to verify your users by sending a verification code via
+SMS (mobile/cell phones text messages) you need to provide a SMS gateway service class.
 
 An example class would be something like:
 
@@ -28,11 +27,11 @@ The arguments provided for the initialize method are:
 - `code` - The code or the message to be sent to the given mobile phone number.
 - `context` - An extra context attribute which can be used to pass e.g. the correct organization for the gateway to utilize.
 
-Then you will need to configure it in the Decidim initializer:
+Then you will need to configure it with the help of Environment Variables:
 
-[source,ruby]
+[source,bash]
 ....
-  config.sms_gateway_service = "MySMSGatewayService"
+export DECIDIM_SMS_GATEWAY_SERVICE="MySMSGatewayService"
 ....
 
 You can find an example on how this is set up at https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/672f5a8938d884940899b4304f0a17e25d42d2a0/app/services/sms_gateway.rb[DecidimBarcelona's app/services/sms_gateway.rb]. Your final implementation will depend on how your SMS provider works.

data/docs/modules/services/pages/social_providers.adoc

@@ -101,7 +101,7 @@ An example of custom initializer could be written as:
 [source,ruby]
 ----
 #config/initializers/omniauth_myprovider.rb
-if Rails.application.secrets.dig(:omniauth, :myprovider).present?
+if Decidim.omniauth_providers[:myprovider]
   Rails.application.config.middleware.use OmniAuth::Builder do
     provider(
       :myprovider,

data/docs/modules/services/pages/timestamp.adoc

@@ -0,0 +1,47 @@
+= Timestamp service configuration
+
+Used by `decidim-initiatives`.
+
+Provide a class to generate a timestamp for a document. The instances of this class are initialized with a hash containing the :document key with the document to be timestamped as value. The instances respond to a timestamp public method with the timestamp.
+
+An example class would be something like:
+
+[source,ruby]
+....
+class MyTimestampService
+  attr_accessor :document
+  def initialize(args = {})
+    @document = args.fetch(:document)
+  end
+  def timestamp
+    # Code to generate timestamp
+    "My timestamp"
+  end
+end
+....
+
+[source,ruby]
+....
+class MyTimestampService
+  attr_accessor :document
+
+  def initialize(args = {})
+    @document = args.fetch(:document)
+  end
+
+  def timestamp
+    # Actual code to add the timestamp
+  end
+end
+....
+
+The arguments provided for the initialize method are:
+
+- `document` - The document that needs to be timestamped
+
+Then you will need to configure it with the help of Environment Variables:
+
+[source,bash]
+....
+export DECIDIM_TIMESTAMP_SERVICE="MyTimestampService"
+....

data/lib/decidim/version.rb

@@ -3,6 +3,6 @@
 # This holds the decidim version and the faker version it uses.
 module Decidim
   def self.version
-    "0.30.2"
+    "0.31.0.rc1"
   end
 end