decidim 0.28.4 → 0.29.0.rc1

data/docs/modules/develop/pages/notifications.adoc

@@ -96,7 +96,7 @@ The keys to be used will have the translation scope corresponding to the event n
 The following are the parts of the notification email:
 
 * _email_subject_, to be customized
-* email_greeting, with a good default, usually there is no need to cusomize it
+* email_greeting, with a good default, usually there is no need to customize it
 * _email_intro_, to be customized
 * _resource_text_ (optional), rendered `html_safe` if present
 * _resource_url_, a link to the involved resource if resource_url and resource_title are present
@@ -108,6 +108,129 @@ All contents except the `email_greeting` use to require customization on each no
 
 Only the `notification_title` is generated in the event class. The rest of the contents are produced by the templates from the `resource` and the `notification` objects.
 
+=== Notification actions
+
+It is possible to render actions into the notifications area. These actions are typically one or more buttons that the user can click to perform an action related to the notification.
+
+In order to add actions to your notification, you need to implement the methods `action_cell`, `action_data` in your event class. The `action_cell` method should return the name of the cell that will be rendered in the notification area. The `action_data` method should return the data that will be passed to the cell.
+
+Currently, there is only one action cell available, `Decidim::Notifications::Actions::ButtonCell`. This cell renders a list of buttons with the text and URL provided in the `action_data`. See the code for the `Decidim::InvitedToGroupEvent` to render actions that allow users to accept or reject a membership invitation to a group:
+
+[source,ruby]
+----
+# decidim-core/app/events/decidim/invited_to_group_event.rb
+
+def membership_id
+  extra["membership_id"]
+end
+
+def invitation
+  @invitation ||= UserGroupMembership.find_by(user:, id: membership_id, role: "invited")
+end
+
+def action_cell
+  "decidim/notification_actions/buttons" if invitation
+end
+
+def action_data
+  [
+    {
+      url: url_helpers.group_invite_path(user_group_nickname, membership_id, format: :json),
+      icon: "check-line",
+      method: "patch",
+      i18n_label: "decidim.group_invites.accept_invitation"
+    },
+    {
+      url: url_helpers.group_invite_path(user_group_nickname, membership_id, format: :json),
+      icon: "close-circle-line",
+      method: "delete",
+      i18n_label: "decidim.group_invites.reject_invitation"
+    }
+  ]
+end
+----
+
+The previous code will render a couple of buttons to accept/reject the invitation but only if the UserGroupMembership is not accepted yet.
+
+Note that the cell returned is "decidim/notification_actions/buttons", if you want to use a custom cell, you should create it in your application and return it accordingly.
+
+The default buttons cell renders as many buttons as defined in the `action_data` array. Each button will handle a "click" event that will make an AJAX request to the URL provided in the button data. The `method` attribute is used to define the HTTP method that will be used in the AJAX request.
+
+So, it is advisable for the controller handling the request to respond with a JSON object with the following structure:
+
+[source,json]
+----
+{
+  "message": "Some message"
+}
+----
+
+Use standard HTTP status codes to indicate the result of the operation. For an example, see the implementation of the `Decidim::GroupInvitesController` that responds with a JSON object only when requests are made with the `:json` format:
+
+[source,ruby]
+----
+# decidim-core/app/controllers/decidim/group_invites_controller.rb
+
+def update
+  enforce_permission_to :accept, :user_group_invitations
+  AcceptGroupInvitation.call(inviting_user_group, current_user) do
+    on(:ok) do
+      respond_to do |format|
+        format.json do
+          render json: { message: t("group_invites.accept.success", scope: "decidim") }
+        end
+        format.all do
+          flash[:notice] = t("group_invites.accept.success", scope: "decidim")
+          redirect_to profile_groups_path(current_user.nickname)
+        end
+      end
+    end
+
+    on(:invalid) do
+      respond_to do |format|
+        format.json do
+          render json: { message: t("group_invites.accept.error", scope: "decidim") }, status: :unprocessable_entity
+        end
+        format.all do
+          flash[:alert] = t("group_invites.accept.error", scope: "decidim")
+          redirect_to profile_groups_path(current_user.nickname)
+        end
+      end
+    end
+  end
+end
+
+def destroy
+  enforce_permission_to :reject, :user_group_invitations
+
+  RejectGroupInvitation.call(inviting_user_group, current_user) do
+    on(:ok) do
+      respond_to do |format|
+        format.json do
+          render json: { message: t("group_invites.reject.success", scope: "decidim") }
+        end
+        format.all do
+          flash[:notice] = t("group_invites.reject.success", scope: "decidim")
+          redirect_to profile_groups_path(current_user.nickname)
+        end
+      end
+    end
+
+    on(:invalid) do
+      respond_to do |format|
+        format.json do
+          render json: { message: t("group_invites.reject.error", scope: "decidim") }, status: :unprocessable_entity
+        end
+        format.all do
+          flash[:alert] = t("group_invites.reject.error", scope: "decidim")
+          redirect_to profile_groups_path(current_user.nickname)
+        end
+      end
+    end
+  end
+end
+----
+
 == Testing notifications
 
 * Test that the event has been published (usually a command test)

data/docs/modules/develop/pages/reminders.adoc

@@ -29,7 +29,7 @@ Reminders consist of the following database objects:
 
 - Reminder which holds the main reminder object that is attached to a user to be reminded about and the component for which the reminder is created for. The reminder can have many deliveries and many records to be reminded about.
 - ReminderDelivery which holds a log of all deliveries sent to the user. This may be useful in cases where we need to audit the system or solve a user support request asking why they were reminded for a specific thing at a specific time. In the backend, this also lets us do conditional logic based on how many times the user has been reminded and when the last reminder was sent.
-- ReminderRecord which holds information about the records the reminder is related to. This lets us combine reminders that are related to multiple records at a time, so that we do not need to send mulitple emails for each record. For example, the budgeting reminders will contain information about in which budgets the user has pending votes which allows us to combine this information in a single email, instead of sending one email per pending order in each budget.
+- ReminderRecord which holds information about the records the reminder is related to. This lets us combine reminders that are related to multiple records at a time, so that we do not need to send multiple emails for each record. For example, the budgeting reminders will contain information about in which budgets the user has pending votes which allows us to combine this information in a single email, instead of sending one email per pending order in each budget.
 
 ==== ReminderRecord states
 
@@ -42,7 +42,7 @@ The ReminderRecord object holds a "state" attribute which tells whether the reco
 
 == Defining a reminder
 
-Reminders can be defined through initializers by defining calling the `registed` method on the reminders registry object at the Decidim main module as follows:
+Reminders can be defined through initializers by defining calling the `registered` method on the reminders registry object at the Decidim main module as follows:
 
 [source,ruby]
 ----

data/docs/modules/develop/pages/reportable.adoc

@@ -20,7 +20,7 @@ A `Reportable` is expected to implement:
 
 === The ReportedContentCell
 
-The reccomended way to render the content of a `Reportable` is with a `decidim/reported_content` cell.
+The recommended way to render the content of a `Reportable` is with a `decidim/reported_content` cell.
 
 [source,ruby]
 ----

data/docs/modules/develop/pages/testing.adoc

@@ -82,7 +82,7 @@ cd decidim-participatory_processes
 bundle exec rake parallel:spec[spec/system/]
 ----
 
-This same commmand without the parallelization (`cd decidim-participatory_processes && bundle exec rspec spec/system/`)
+This same command without the parallelization (`cd decidim-participatory_processes && bundle exec rspec spec/system/`)
 took 26 minutes 21 seconds. With parallel_specs, this runs in 10 minutes 27 seconds.
 
 [NOTE]
@@ -94,7 +94,7 @@ These numbers are depend on your machine, the configuration was:
 
 == Jest
 
-We use Jest for testing our Javascript code.
+We use Jest for testing our JavaScript code.
 
 === Running a specific test file
 

data/docs/modules/develop/pages/troubleshooting_metrics.adoc

@@ -11,7 +11,7 @@ We have identified two main problems:
 
 === Metrics generation crashing
 
-We have identified only one culprit here: "orphans" records, meaning records whose related component or participatory space cannot be found in the database. This is because in a previous decidim release `PartipatorySpaces` could be deleted but they were not deleted properly. So any application that has deleted a participatory space in the past, will probably have unrelated records that will make some metrics calculation crash.
+We have identified only one culprit here: "orphans" records, meaning records whose related component or participatory space cannot be found in the database. This is because in a previous decidim release `ParticipatorySpaces` could be deleted but they were not deleted properly. So any application that has deleted a participatory space in the past, will probably have unrelated records that will make some metrics calculation crash.
 
 === Peaks in generated metrics
 
@@ -32,7 +32,7 @@ For a given metric type (`rake decidim:metrics:list`) that has duplicates:
 For orphan records, you can do the following:
 
 * Back up the database.
-* Delete orphan records fromt the console (code is below).
+* Delete orphan records from the console (code is below).
 * Delete "comments" metrics and recalculate them following the https://github.com/decidim/decidim/blob/release/0.18-stable/CHANGELOG.md#participants-metrics[aforementioned example].
 
 === Some queries that may help

data/docs/modules/develop/pages/view_models_aka_cells.adoc

@@ -25,7 +25,7 @@ The `label` option accepts this arguments:
 
 * `false` or `"false"` will not render the label from the locales `t(model.class.model_name.i18n_key, scope: "activerecord.models", count: 1)`
 * `true` or `"true"` will render the translation from
-* `"whathever string"` will render it as String
+* `"whatever string"` will render it as String
 
 == Introducing a Card Cell to a `component`
 

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

@@ -6,6 +6,7 @@ As a technopolitical project, Decidim needs several things to work. This is a no
 
 . Choose a *domain or subdomain* for your application. Some typical names involve "Participation" or "Decision" conjugations.
 . Choose which *languages* do you want for your application. In case that your language is not supported you should translate it on https://crowdin.com/project/decidim[Crowdin].
+. Configure the *time zone* for your organization. If you change it afterwards you will need to review all the dates from your contents.
 . Customize the xref:customize:styles.adoc[*look and feel*] (colors, pictures, fonts, etc).
 . Configure *SSL*:
 .. We recommend using at least *https://letsencrypt.org/[Let's Encrypt]* for minimum security.
@@ -32,8 +33,8 @@ As a technopolitical project, Decidim needs several things to work. This is a no
 == Contents
 
 . Ideally you will have a *Team* formed with experts on IT, Communication, Participation, Design and Law.
-. Texts for at least, *terms of service, privacy policy and frequently asked questions*. To show the "Terms of service" body text in the "Sign Up Form", it is a requirement that the slug of this page to be equal `terms-of-service`.
-. Comply with your current *legal requirements*, like to registrate your privacy policy with the autorities (eg LOPD on Spain).
+. Texts for at least, *terms of service, privacy policy and frequently asked questions*. To show the "Terms of service" body text in the "Create an account form", it is a requirement that the slug of this page to be equal `terms-of-service`.
+. Comply with your current *legal requirements*, like to registrate your privacy policy with the authorities (eg LOPD on Spain).
 . Fill the *Participatory Processes Configuration Form* to prepare your Participatory Process for Decidim.
 . Read the *xref:admin:index.adoc[Administration manual]*.
 . Participate on *http://meta.decidim.org[Metadecidim]*.

data/docs/modules/install/pages/empty-database.adoc

@@ -1,6 +1,6 @@
 = Empty database installation
 
-You may want to setup your Decidim installation with an empty database to take full control of all aspects of the Decidim organization. Please follow the steps bellow to start with an empty database:
+You may want to setup your Decidim installation with an empty database to take full control of all aspects of the Decidim organization. Please follow the steps below to start with an empty database:
 
 . Follow steps 1 through 5 of the xref:install:manual.adoc[Manual installation tutorial].
 
@@ -23,9 +23,9 @@ bin/rails decidim_system:create_admin
 bundle exec rails s
 ----
 
-Now, you will be able to login to the system panel with the provided credentials. The application automatically redirects you to the system panel when you do not have any organizations configured and when you enter the system's URL in your browser. The default URL for development is `http://localhost:3000`.
+Now, you will be able to log in to the system panel with the provided credentials. The application automatically redirects you to the system panel when you do not have any organizations configured and when you enter the system's URL in your browser. The default URL for development is `http://localhost:3000`.
 
-After you have configured the organization from the system panel, log out of the system panel and type in the URL of the organization to the browser after which you should see a rather empty home page of your organization. You can now login with the admin user you created when configuring the organization. Note that you will need to set a password for the admin user before being able to login with that user.
+After you have configured the organization from the system panel, log out of the system panel and type in the URL of the organization to the browser after which you should see a rather empty home page of your organization. You can now log in with the admin user you created when configuring the organization. Note that you will need to set a password for the admin user before being able to log in with that user.
 
 At the development environment, you have https://github.com/ryanb/letter_opener[Letter opener] available for viewing the emails that the system sends. You can access it through the `/letter_opener` URL within the domain where your Rails server is running at (typically `http://localhost:3000`).
 

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

@@ -52,7 +52,7 @@ You should now setup your database:
 
 [source,console]
 ----
-bin/rails db:create db:migrate db:seed
+bin/rails db:create db:migrate assets:precompile db:seed
 ----
 
 This will also create some example data through the seeds so that you can start testing the application straight away. The following table contains some example user accounts that you can start testing the system with.
@@ -81,7 +81,7 @@ This will also create some example data through the seeds so that you can start
 
 |===
 
-This data will not be created in production environments. If you insist on adding it in production, run: `$ SEED=true rails db:setup`. We recomend that you first login as a system user and edit the hostname for the organization. Set it as your production environment's domain, without the protocol and the port (so if your domain/hostname is `+https://example.org:3000+`, you need to write `example.org` in the organization's host field).
+This data will not be created in production environments. If you insist on adding it in production, run: `$ SEED=true rails db:setup`. We recommend that you first login as a system user and edit the hostname for the organization. Set it as your production environment's domain, without the protocol and the port (so if your domain/hostname is `+https://example.org:3000+`, you need to write `example.org` in the organization's host field).
 
 You can now start your server!
 
@@ -142,7 +142,7 @@ We also have other guides on how to configure some extra mandatory components:
 
 == Deploy
 
-Once you have successfully deployed your applicaton to your favorite platform, you will need to create your `System` user. You can do this using the following command in your terminal:
+Once you have successfully deployed your application to your favorite platform, you will need to create your `System` user. You can do this using the following command in your terminal:
 
 [source,console]
 ----
@@ -153,7 +153,7 @@ The command asks for an email and a password. For security, the password will no
 
 This will create a system user with the email and password you provided. We recommend using a random password generator and saving it to a password manager, so you have a more secure credentials.
 
-After this, visit the `/system` panel and login with the email and passwords you just entered and create your organization. Now you are ready to setup your organization and after that you are done! 🎉
+After this, visit the `/system` panel and log in with the email and passwords you just entered and create your organization. Now you are ready to setup your organization and after that you are done! 🎉
 
 === What are organizations?
 
@@ -172,7 +172,7 @@ There are several things you need to check before making your putting your appli
 
 == Contributing
 
-We always welcome new contributors of all levels to the project. If you are not confident enough with Ruby or web development you can look for https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22[issues labeled `good first issue`] to start contibuting and learning the internals of the project by doing easy jobs.
+We always welcome new contributors of all levels to the project. If you are not confident enough with Ruby or web development you can look for https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22[issues labeled `good first issue`] to start contributing and learning the internals of the project by doing easy jobs.
 
 We also have a xref:develop:guide.adoc[developer's reference] that will help you getting started with your environment and our daily commands, routines, etc.
 

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

@@ -27,7 +27,7 @@ First, we are going to install https://github.com/rbenv/rbenv[rbenv], for managi
 [source,bash]
 ----
 sudo apt update
-sudo apt install -y build-essential curl git libssl-dev zlib1g-dev p7zip
+sudo apt install -y build-essential curl git libssl-dev zlib1g-dev
 git clone https://github.com/rbenv/rbenv.git ~/.rbenv
 echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
 echo 'eval "$(rbenv init -)"' >> ~/.bashrc
@@ -133,6 +133,7 @@ We should now create your database. For a first local installation, we recommend
 [source,bash]
 ----
 bin/rails db:create db:migrate
+bin/rails assets:precompile
 bin/rails db:seed
 ----
 
@@ -165,5 +166,5 @@ The seed data will not be created in production environments, if you still want
 
 [source,bash]
 ----
-SEED=true rails db:seed
+SEED=true rails assets:precompile db:seed
 ----

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

@@ -37,7 +37,7 @@ bin/rails decidim:upgrade
 bin/rails db:migrate
 ----
 
-In theory, that would be all. However, you need to be careful in certain situations, specially if your copy of Decidim has many code modifications. We'd recommend to always test the upgrade following Ruby on Rails best practices: working with development mode in localhost, deploying to a staging/preproduction server to test it manually (specially your modifications) and finally deploying to production. As an alternative you can test the upgrade in a separate machine with the same configuration (If using Digitalocean you can create an snapshot of the server, tested the update, and then remove it, similar process on other providers).
+In theory, that would be all. However, you need to be careful in certain situations, specially if your copy of Decidim has many code modifications. We'd recommend to always test the upgrade following Ruby on Rails best practices: working with development mode in localhost, deploying to a staging/preproduction server to test it manually (specially your modifications) and finally deploying to production. As an alternative you can test the upgrade in a separate machine with the same configuration (If using DigitalOcean you can create an snapshot of the server, tested the update, and then remove it, similar process on other providers).
 
 == From git repositories
 
@@ -80,7 +80,7 @@ gem "decidim-initiatives", DECIDIM_VERSION
 gem "decidim-dev", DECIDIM_VERSION
 ----
 
-== Compatiblity versions matrix
+== Compatibility versions matrix
 
 There are different versions of Decidim that are compatible with different versions of Ruby and Node. You can check the following table to see which versions are compatible with each other:
 

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

@@ -50,7 +50,7 @@ Google Cloud Storage requires you to use the `gsutil` command line tool to set t
 gsutil cors set cors.json gs://your-bucket-name
 ----
 
-Before running that command you need to have a `cors.json` file in the same directory where you are runnign the command from with the following content (replace `https://www.example.com` with the actual domain of your service):
+Before running that command you need to have a `cors.json` file in the same directory where you are running the command from with the following content (replace `https://www.example.com` with the actual domain of your service):
 
 [source,json]
 ----

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

@@ -4,7 +4,6 @@ There are multiple services that can be enabled in a Decidim installation. It is
 
 * xref:services:activejob.adoc[Active Job]
 * xref:services:activestorage.adoc[Active Storage]
-* xref:services:elections_bulletin_board.adoc[Elections Bulletin Board]
 * xref:services:etherpad.adoc[Etherpad]
 * xref:services:maps.adoc[Maps]
 * xref:services:sms.adoc[SMS]

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

@@ -191,7 +191,7 @@ Decidim works fine when some of the services are disabled individually but obvio
 
 === Global geocoder configurations
 
-In the Dedicim initialiser (`config/initializers/decidim.rb`) you will also see a commented section for the global geocoder configurations commented as follows:
+In the Decidim initialiser (`config/initializers/decidim.rb`) you will also see a commented section for the global geocoder configurations commented as follows:
 
 [source,ruby]
 ----
@@ -268,7 +268,7 @@ In the example configuration, we assume you have used the following domain for t
 
 https://tiles.example.org
 
-=== Static map images: Openstreetmap static maps server (osm-static-maps)
+=== Static map images: OpenStreetMap static maps server (osm-static-maps)
 
 Some pages in Decidim display static map images which need to be fetched from an external server.
 The tiles server does not provide such static images by itself because one static map image may need multiple tiles to be combined into one.

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

@@ -2,7 +2,7 @@
 
 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 (such as xref:admin:spaces/votings.adoc[Votings]), and external modules could use it too.
+This service can also be used by some spaces, and external modules could use it too.
 
 An example class would be something like:
 

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

@@ -42,14 +42,14 @@ twitter:
 == Google
 
 . Navigate to https://console.developers.google.com[Google Developers Page]
-. Follow the 'Create projecte' link.
+. Follow the 'Create project' link.
 . Fill in the name of your app.
-. Navigate to the projecte dashboard and click on "Enable API"
+. Navigate to the project dashboard and click on "Enable API"
 . Click on `Google+ API` and then "Enable"
 . Navigate to the project credentials page and click on `OAuth consent screen`.
 . Fill in the `Product name` field
 . Click on `Credentials` tab and click on "Create credentials" button. Select `OAuth client ID`.
-. Select `Web applications`. Fill in the `Authorized Javascript origins` with your url. Then fill in the `Authorized redirect URIs` with your url and append the path `/users/auth/google_oauth2/callback`.
+. Select `Web applications`. Fill in the `Authorized JavaScript origins` with your url. Then fill in the `Authorized redirect URIs` with your url and append the path `/users/auth/google_oauth2/callback`.
 . Copy the CLIENT_ID AND CLIENT_SECRET
 . Paste credentials in `config/secrets.yml` or in the organization configuration. Ensure the `enabled` attribute is `true`.
 

data/lib/decidim/gem_manager.rb

@@ -223,6 +223,8 @@ group :development do
   gem "faker", "#{Gem.loaded_specs["decidim-dev"].dependencies.select { |a| a.name == "faker" }.first.requirement}"
   gem "letter_opener_web", "#{fetch_gemfile_version("letter_opener_web")}"
   gem "listen", "#{fetch_gemfile_version("listen")}"
+  gem "spring", "#{fetch_gemfile_version("spring")}"
+  gem "spring-watcher-listen", "#{fetch_gemfile_version("spring-watcher-listen")}"
   gem "web-console", "#{fetch_gemfile_version("web-console")}"
 end
 )

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.28.4"
+    "0.29.0.rc1"
   end
 end