decidim 0.24.0 → 0.25.0.rc1

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

@@ -186,7 +186,7 @@ module Decidim
           # autocompletion functionality in the front-end:
           class Builder < Decidim::Map::Autocomplete::Builder
             def javascript_snippets
-              template.javascript_include_tag("decidim/geocoding/provider/your_provider")
+              template.javascript_pack_tag("decidim/geocoding/provider/your_provider")
             end
           end
         end
@@ -196,7 +196,7 @@ module Decidim
 end
 ----
 
-To see an example of the front-end JavaScript code that handles the geocoding requests, you can take a look at the link:/decidim-core/app/assets/javascripts/decidim/geocoding/provider/here.js.es6[HERE Maps example].
+To see an example of the front-end JavaScript code that handles the geocoding requests, you can take a look at the link:/decidim-core/app/packs/src/decidim/geocoding/provider/here.js.es6[HERE Maps example].
 You will have to listen to the `geocoder-suggest.decidim` JavaScript event on all elements that have the `data-decidim-geocoding` attribute defined which contains all the configurations returned by the builder's `builder_options` method as mentioned above.
 For example, if you passed the following configuration from that method:
 

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

@@ -19,7 +19,7 @@ Decidim.content_blocks.register(:newsletter_template, :my_template) do |content_
     {
       name: :main_image,
       uploader: "Decidim::NewsletterTemplateImageUploader",
-      preview: -> { ActionController::Base.helpers.asset_path("decidim/placeholder.jpg") }
+      preview: -> { ActionController::Base.helpers.asset_pack_path("media/images/placeholder.jpg") }
     }
   ]
 

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

@@ -74,9 +74,11 @@ Running it as is, or passing it the `--help` flag, will render the help section
 bin/changelog_generator <GITHUB_TOKEN> <SHA>
 ----
 
+This command will create a `temporary_changelog.md` in the root of the project, so you can inspect this file and generated changelog.
+
 If you have some elements in the `Unsorted` section of the output, you can review the PRs individually, fix the title and the tags and rerun the script. Those PRs with the tags fixed will be automatically sorted. Labelling the PRs as they're opened or merged is encouraged to save some time when producing the changelog.
 
-You can copy-paste the output of the command to the relevant sections of the changelog file.
+You can copy-paste the contents of the temporary changelog file to the relevant sections of the Changelog file.
 
 == Release Candidates
 

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

@@ -47,3 +47,14 @@ bundle exec rake test_all
 ----
 
 But beware, it takes a long time... :)
+
+== Continuous integration
+
+The tests are also run when a new commit is added to the `develop` or releases
+branches, or added to a Pull Request. In the latter case, only the tests for
+the modules affected by any the PR commits will be executed.
+
+This means that the workflows defined for each module in the folder
+`.github/workflows/` should be always updated with the module's dependencies
+list. The script `.github/workflows/dependencies.sh` can be helpful to keep
+those files updated until we have an automatic process to do it.

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

@@ -29,21 +29,10 @@ The `label` option accepts this arguments:
 
 == Introducing a Card Cell to a `component`
 
-* add *dependency* to "decidim-*.gemspec"
+* Add the module cell paths to cell view paths in `decidim-<module>/lib/decidim/<module>/engine.rb`
 +
 [source,rb]
 ----
-s.add_dependency "cells-erb", "~> 0.1.0"
-s.add_dependency "cells-rails", "~> 0.0.9"
-----
-
-* *require* cells in `decidim-<module>/lib/decidim/<module>/engine.rb`
-+
-[source,rb]
-----
-require "cells/rails"
-require "cells-erb"
-
 initializer "decidim_<module>.add_cells_view_paths" do
   Cell::ViewModel.view_paths << File.expand_path("#{Decidim::<Module>::Engine.root}/app/cells")
   Cell::ViewModel.view_paths << File.expand_path("#{Decidim::<Module>::Engine.root}/app/views") # for partials

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

@@ -1,40 +1,39 @@
 = Manual installation tutorial
 
-== Step by step
-
 In order to develop on decidim, you'll need:
 
 * *Git* 2.15+
-* *PostgreSQL* 9.5+
-* *Ruby* 2.5.0 (2.3+ should work just fine, but that's the version we test against)
-* *NodeJS* 9.x.x
+* *PostgreSQL* 12.7+
+* *Ruby* 2.7.1
+* *NodeJS* 15.14.x
+* *Npm* 7.7.x
 * *ImageMagick*
 * *Chrome* browser and https://sites.google.com/a/chromium.org/chromedriver/[chromedriver].
 
-We're starting with an Ubuntu 16.04 LTS. This is an opinionated guide and YMMV, so if you're free to use the technology that you fell most comfortable on. If you have any doubts and you're blocked you can go and ask on https://gitter.im/decidim/decidim[our Gitter]. We recommend that you follow some Ruby on Rails tutorials (like http://guides.rubyonrails.org/getting_started.html[Getting Started with Ruby on Rails]) and have some knowledge on how gems and engines work.
+We're starting with an Ubuntu 20.04 LTS. This is an opinionated guide, so you're free to use the technology that you are most comfortable. If you have any doubts and you're blocked you can go and ask on https://gitter.im/decidim/decidim[our Gitter].
+
+We recommend to have at least some basic proficiency in Ruby on Rails (a good starting point is http://guides.rubyonrails.org/getting_started.html[Getting Started with Ruby on Rails]) and have some knowledge on how gems work.
 
-On this tutorial we'll see how to install rbenv, PostgreSQL and Decidim, and how to configure everything together.
+In this guide, we'll see how to install rbenv, PostgreSQL and, Decidim, and how to configure everything together.
 
-=== Installing rbenv
+== 1. Installing rbenv
 
-First we're going to install rbenv, for managing various ruby versions. We're following the guide from https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-16-04[DigitalOcean]. You could also use https://rvm.io/[rvm] as an alternative on this step. On these instruction we're using the latest ruby published version at the moment (2.5.3), but you should check this out on https://www.ruby-lang.org/en/downloads/[Ruby official website].
+First, we're going to install https://github.com/rbenv/rbenv[rbenv], for managing various ruby versions. You could also use https://rvm.io/[rvm] or https://github.com/asdf-vm/asdf[asdf] as alternatives on this step. Mind that at the moment, Decidim isn't compatible with Ruby 3.0.
 
 [source,bash]
 ----
 sudo apt update
-sudo apt install -y build-essential autoconf bison libssl-dev libyaml-dev libreadline-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm3 libgdbm-dev libicu-dev
+sudo apt install -y build-essential 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
 source ~/.bashrc
 git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
-rbenv install 2.5.3
-rbenv global 2.5.3
-echo "gem: --no-document" > ~/.gemrc
-gem install bundler
+rbenv install 2.7.1
+rbenv global 2.7.1
 ----
 
-=== Installing PostgreSQL
+== 2. Installing PostgreSQL
 
 Now we're going to install PostgreSQL for the database:
 
@@ -44,20 +43,19 @@ sudo apt install -y postgresql libpq-dev
 sudo -u postgres psql -c "CREATE USER decidim_app WITH SUPERUSER CREATEDB NOCREATEROLE PASSWORD 'thepassword'"
 ----
 
-You need to change the password (on this example is "thepassword") and save it somewhere to configure it later with the application.
+You need to change the password (in this example is "thepassword") and save it somewhere to configure it later with the application.
 
-=== Installing Decidim
+== 3. Installing Decidim
 
-Next, we need to install the `decidim` gem:
+Next, we need to install the `decidim` gem with its dependencies:
 
 [source,bash]
 ----
-gem install bootsnap
-gem install listen
+sudo apt install -y libicu-dev nodejs imagemagick
 gem install decidim
 ----
 
-Afterwards, we can create an application with the nice `decidim` executable, where `decidim_application` is your application name (ie decidim.barcelona):
+Then we can create an application with the `decidim` executable, where `decidim_application` is your application name (ie DecidimBarcelona):
 
 [source,bash]
 ----
@@ -69,13 +67,13 @@ We recommend that you save it all on Git.
 
 [source,bash]
 ----
-git init .
-git commit -m "Initial commit. Generated with Decidim 0.X https://decidim.org"
+git add .
+git commit -m "Initial commit. Generated with Decidim https://decidim.org"
 ----
 
-=== Configure the database
+== 4. Configure the database
 
-You need to modify your secrets (see `config/database.yml`). For this you can use https://github.com/laserlemon/figaro[figaro], https://github.com/bkeepers/dotenv[dotenv] or https://github.com/rbenv/rbenv-vars[rbenv-vars]. You should always be careful of not uploading your plain secrets on git or your version control system. You can also upload the encrypted secrets, using the sekrets gem or if you're on Ruby on Rails greater than 5.1 you can do it natively.
+Modify your secrets (see `config/database.yml`). For this you can use https://github.com/laserlemon/figaro[figaro], https://github.com/bkeepers/dotenv[dotenv] or https://github.com/rbenv/rbenv-vars[rbenv-vars]. You should always be careful of not uploading your plain secrets on git or your version control system. You can also upload the encrypted secrets, using the sekrets gem or if you're on Ruby on Rails greater than 5.1 you can do it natively.
 
 For instance, for working with figaro, add this to your `Gemfile`:
 
@@ -92,13 +90,13 @@ bundle install
 bundle exec figaro install
 ----
 
-Next add this to your `config/application.yml`, using the setup the PostgreSQL database name, user and password that you configure before.
+Next, add this to your `config/application.yml`, using the setup PostgreSQL database name, user and, password that you've configured before.
 
 [source,yaml]
 ----
 DATABASE_HOST: localhost
 DATABASE_USERNAME: decidim_app
-DATABASE_PASSWORD: your_password
+DATABASE_PASSWORD: thepassword
 ----
 
 Finally, save it all to git:
@@ -106,12 +104,12 @@ Finally, save it all to git:
 [source,bash]
 ----
 git add .
-git commit -m "Adds figaro configuration management"
+git commit -m "Add figaro configuration management"
 ----
 
-=== Initializing your app for local development
+== 5. Initializing your app for local development
 
-We should now setup your database:
+We should now create your database:
 
 [source,bash]
 ----
@@ -119,29 +117,34 @@ bin/rails db:create db:migrate
 bin/rails db:seed
 ----
 
-This will also create some default data so you can start testing the app:
+This will also create some default data so you can start testing the app, with an administrator account with email admin@example.org and password `decidim123456`
 
-* A `Decidim::System::Admin` with email `system@example.org` and password `decidim123456`, to log in at `/system`.
-* A `Decidim::Organization` named `Decidim Staging`. You probably want to change its name and hostname to match your needs.
-* A `Decidim::User` acting as an admin for the organization, with email `admin@example.org` and password `decidim123456`.
-* A `Decidim::User` that also belongs to the organization but it's a regular user, with email `user@example.org` and password `decidim123456`.
+== 6. Start your web server
 
-This data won't be created in production environments, if you still want to do it, run:
+You can now start your server!
 
 [source,bash]
 ----
-SEED=true rails db:setup
+bin/rails s
 ----
 
-==== Notes
+Visit http://localhost:3000 to see your app running. 🎉 🎉
 
-When you run `bin/rails db:migrate` you should see a lot of output. If you don't, or if you run into errors seeding your database, try runnning `bin/rake decidim:upgrade` before.
+[NOTE]
+====
+With these steps you would only have an initial installation for trying Decidim, but it still needs lots of things to take in account. If you want a working production system then we recommend that you follow the https://platoniq.github.io/decidim-install/[Decidim Install guide by Platoniq].
+====
 
-You can now start your server!
+== Extra notes
+
+Other user accounts that you'll have in the seeds are:
+
+* To participate as a regular user, with email `user@example.org` and password `decidim123456`.
+* To manage the Multitenant and being able to log in at `/system`, with email `system@example.org` and password `decidim123456`.
+
+The seed data won't be created in production environments, if you still want to do it (for instance, for a Demo or Staging server), run:
 
 [source,bash]
 ----
-bin/rails s
+SEED=true rails db:seed
 ----
-
-Visit http://localhost:3000 to see your app running. 🎉 🎉

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

@@ -43,7 +43,7 @@ In theory, that would be all. However, you need to be careful in certain situati
 
 == From git repositories
 
-For managing the gems we use the standard Rails gem called Bundler, where you can also point to https://bundler.io/v2.1/guides/git.html[git repositories and branches]. This is specially useful if you want to try an unreleased version, then you can do so by pointing to the release branch.
+For managing the gems we use the standard Rails gem called Bundler, where you can also point to https://bundler.io/v2.2/guides/git.html[git repositories and branches]. This is specially useful if you want to try an unreleased version, then you can do so by pointing to the release branch.
 
 [source,ruby]
 ----

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

@@ -5,11 +5,13 @@
 This is a work in progress and is not fully working yet.
 ====
 
-In order to celebrate https://en.wikipedia.org/wiki/End-to-end_auditable_voting_systems[End-to-end auditable votings] using the Elections module, you will need to connect your Decidim instance with an instance of the https://github.com/decidim/decidim-bulletin-board/[Decidim Bulletin Board application], preferably run by an independent organization.
+In order to celebrate https://en.wikipedia.org/wiki/End-to-end_auditable_voting_systems[End-to-end auditable votings] using the Elections module, you will need to connect your Decidim instance with an instance of the https://github.com/decidim/decidim-bulletin-board/[Decidim Bulletin Board application].
+
+*Note*: The connected Bulletin Board instance is used by all organizations, therefore it's recommended to set it up by an independent organization.
 
 == Identification pair of keys generation
 
-The first step needed to setup the connection is to generate an a pair of keys to identify the application against the Bulletin Board.
+The first step needed to setup the connection is to generate a pair of keys to identify the application against the Bulletin Board.
 This can be done running the following rake task in your application environment:
 
 [source,sh]
@@ -17,32 +19,33 @@ This can be done running the following rake task in your application environment
 bundle exec rake decidim_elections:generate_identification_keys
 ----
 
-This task will output the generated private and public keys. You should copy the public key and send it to the Bulletin Board administrator through a secure channel. Together with the key, send your *Authority name* to the Bulletin Board administrator and store its value on the environment variable `BULLETIN_BOARD_AUTHORITY_NAME`.
+This task will output the generated private and public keys. You should copy the public key and send it, together with your *Authority name* to the Bulletin Board administrator through a secure channel. Together with the key, send your *Authority name* to the Bulletin Board administrator.
+
+After that, copy the private key and store that value on the environment variable `AUTHORITY_PRIVATE_KEY` and your *Authority name* on the variable `AUTHORITY_NAME`.
 
-After that, copy the private key and store that value on the environment variable `BULLETIN_BOARD_IDENTIFICATION_PRIVATE_KEY`.
+Ensure that the private key is not lost between deployments and servers reboots and that it can only be accessed by the application.
 
-Ensure that the private key is not lost between deployments and servers reboots and that only can be accessed by the application.
+As an administrator of the Bulletin Board, you find the steps to be taken https://github.com/decidim/decidim-bulletin-board/blob/develop/decidim-bulletin_board-app/docs/setup.md#adding-an-authority-as-a-client-of-the-bulletin-board[here].
 
 == Configuration of the Bulletin Board application
 
 The Bulletin Board administrator will store the received public key in their server and will send you back an API key.
-To complete the setup process you should store this API key and the Bulletin Board URL address on the environment variables `BULLETIN_BOARD_API_KEY` and `BULLETIN_BOARD_SERVER`, respectively.
+To complete the setup process you should store this API key and the Bulletin Board URL address on the environment variables `AUTHORITY_API_KEY` and `BULLETIN_BOARD_SERVER`, respectively.
 
 The following YAML snippet with all the defined environment variables should be used in the `default` block of your application `config/secrets.yml` file.
 Maybe this is already done, as it was included in the Decidim applications generator during the development of the Elections module.
 
 [source,yaml]
 ----
-  bulletin_board:
-    identification_private_key: <%= ENV["BULLETIN_BOARD_IDENTIFICATION_PRIVATE_KEY"] %>
-    server: <%= ENV["BULLETIN_BOARD_SERVER"] %>
-    api_key: <%= ENV["BULLETIN_BOARD_API_KEY"] %>
-    number_of_trustees: <%= ENV["BULLETIN_BOARD_NUMBER_OF_TRUSTEES"] %>
-    authority_name: <%= ENV["BULLETIN_BOARD_AUTHORITY_NAME"] %>
-    scheme:
-      name: <%= ENV["BULLETIN_BOARD_SCHEME_NAME"] %>
-      parameters:
-        quorum: <%= ENV["BULLETIN_BOARD_SCHEME_QUORUM"] %>
+  elections:
+    bulletin_board_server: <%= ENV["BULLETIN_BOARD_SERVER"] %>
+    bulletin_board_public_key: <%= ENV["BULLETIN_BOARD_PUBLIC_KEY"] %>
+    authority_api_key: <%= ENV["AUTHORITY_API_KEY"] %>
+    authority_name: <%= ENV["AUTHORITY_NAME"] %>
+    authority_private_key: <%= ENV["AUTHORITY_PRIVATE_KEY"] %>
+    scheme_name: <%= ENV["ELECTIONS_SCHEME_NAME"] %>
+    number_of_trustees: <%= ENV["ELECTIONS_NUMBER_OF_TRUSTEES"] %>
+    quorum: <%= ENV["ELECTIONS_QUORUM"] %>
 ----
 
 After restarting the Decidim instance, administrator users will be able to create elections on the configured Bulletin Board.

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

@@ -82,7 +82,7 @@ Instructions in how to configure the client applications can be found in the mod
 * Or you can create a new strategy, as the https://github.com/decidim/omniauth-decidim[Decidim OmniAuth Strategy]. This strategy allow users from a Decidim instance to login in other Decidim instance. For example, this strategy is used to allow https://decidim.barcelona[decidim.barcelona] users to log into https://meta.decidim.barcelona[meta.decidim.barcelona].
 * Once you have defined your strategy, you can configure it in the `config/secrets.yml` or in the organization configuration, as it is done for the built-in providers.
 * By default, Decidim will search in its icons library for an icon named as the provider. You can change this adding an `icon` or `icon_path` attribute to the provider configuration. The `icon` attribute sets the icon name to look for in the Decidim's icons library. The `icon_path` attribute sets the route to the image that should be used.
-* Here is an example of the configuration section for the Decidim strategy, using an icon located on the application's `app/assets/images` folder:
+* Here is an example of the configuration section for the Decidim strategy, using an icon located on the application's `app/packs/images` folder:
 
 [source,yaml]
 ----

data/lib/decidim.rb

@@ -23,7 +23,3 @@ require "decidim/accountability"
 require "decidim/debates"
 require "decidim/sortitions"
 require "decidim/blogs"
-
-# Module declaration.
-module Decidim
-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.24.0"
+    "0.25.0.rc1"
   end
 end

data/lib/tasks/decidim_tasks.rake

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+def ensure_log_goes_to_stdout
+  old_logger = Webpacker.logger
+  Webpacker.logger = ActiveSupport::Logger.new($stdout)
+  yield
+ensure
+  Webpacker.logger = old_logger
+end
+
+namespace :decidim do
+  namespace :webpacker do
+    desc "Install deps with npm"
+    task :npm_install do
+      Dir.chdir(File.join(__dir__, "../..")) do
+        system "npm install"
+      end
+    end
+
+    desc "Compile JavaScript packs using webpack for production with digests"
+    task compile: [:npm_install, :environment] do
+      Webpacker.with_node_env("production") do
+        ensure_log_goes_to_stdout do
+          if Decidim.webpacker.commands.compile
+            # Successful compilation!
+            puts "SUCCESS"
+            Dir.chdir(File.join(__dir__, "../..")) do
+              system "cp -r public/* #{Rails.root.join("public")}"
+            end
+          else
+            # Failed compilation
+            puts "FAIL"
+            exit!
+          end
+        end
+      end
+    end
+  end
+end
+
+def npm_install_available?
+  rails_major = Rails::VERSION::MAJOR
+  rails_minor = Rails::VERSION::MINOR
+
+  rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+
+def enhance_assets_precompile
+  # npm:install was added in Rails 5.1
+  deps = npm_install_available? ? [] : ["decidim:webpacker:npm_install"]
+  Rake::Task["assets:precompile"].enhance(deps) do
+    Rake::Task["decidim:webpacker:compile"].invoke
+  end
+end
+
+# Compile packs after we've compiled all other assets during precompilation
+skip_webpacker_precompile = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_precompile
+  if Rake::Task.task_defined?("assets:precompile")
+    enhance_assets_precompile
+  else
+    Rake::Task.define_task("assets:precompile" => "decidim:webpacker:compile")
+  end
+end
+
+namespace :decidim do
+  namespace :assets do
+    desc "Remove 'node_modules' folder"
+    task rm_node_modules: :environment do
+      Dir.chdir(File.join(__dir__, "../..")) do
+        puts "Removing node_modules folder"
+        system "rm -rf node_modules"
+      end
+    end
+  end
+end
+
+def enhance_assets_clean
+  # npm:install was added in Rails 5.1
+  Rake::Task["assets:clean"].enhance([]) do
+    Rake::Task["decidim:assets:rm_node_modules"].invoke
+  end
+end
+
+unless skip_webpacker_precompile
+  if Rake::Task.task_defined?("assets:clean")
+    enhance_assets_clean
+  else
+    Rake::Task.define_task("assets:clean" => "decidim:assets:rm_node_modules")
+  end
+end