decidim 0.7.4 → 0.8.0

data/Rakefile

@@ -4,11 +4,8 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "generators/decidim/app_generator"
 require "generators/decidim/docker_generator"
-require "decidim/dev"
 
-load "decidim-dev/lib/tasks/test_app.rake"
-
-DECIDIM_GEMS = %w(core system admin api participatory_processes assemblies pages meetings proposals comments accountability budgets surveys dev).freeze
+DECIDIM_GEMS = %w(core system admin api participatory_processes assemblies pages meetings proposals comments accountability budgets surveys verifications dev).freeze
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -35,25 +32,21 @@ def replace_file(name, regexp, replacement)
   File.open(name, "w") { |f| f.write(new_content) }
 end
 
+def version
+  File.read("#{__dir__}/.decidim-version").strip
+end
+
 desc "Update version in all gems to the one set in the `.decidim-version` file"
 task :update_versions do
-  version = File.read("#{__dir__}/.decidim-version").strip
-
   replace_file(
     "#{__dir__}/package.json",
     /^  "version": "[^"]*"/,
     "  \"version\": \"#{version}\""
   )
 
-  replace_file(
-    "#{__dir__}/package-lock.json",
-    /^  "version": "[^"]*"/,
-    "  \"version\": \"#{version}\""
-  )
-
-  DECIDIM_GEMS.each do |gem_name|
+  DECIDIM_GEMS.each do |name|
     replace_file(
-      "#{__dir__}/decidim-#{gem_name}/lib/decidim/#{gem_name}/version.rb",
+      "#{__dir__}/decidim-#{name}/lib/decidim/#{name}/version.rb",
       /def self\.version(\s*)"[^"]*"/,
       "def self.version\\1\"#{version}\""
     )
@@ -68,19 +61,27 @@ end
 
 desc "Installs all gems locally."
 task :install_all do
-  sh "rake install", verbose: false
-  DECIDIM_GEMS.each do |gem_name|
-    Dir.chdir("#{__dir__}/decidim-#{gem_name}") do
-      sh "rake install", verbose: false
+  system "rake install:local"
+  DECIDIM_GEMS.each do |name|
+    Dir.chdir("#{__dir__}/decidim-#{name}") do
+      system "rake install:local"
     end
   end
 end
 
+desc "Uninstalls all gems locally."
+task :uninstall_all do
+  system("gem uninstall decidim -v #{version} --executables --force")
+  DECIDIM_GEMS.each do |name|
+    system("gem uninstall decidim-#{name} -v #{version} --executables --force")
+  end
+end
+
 desc "Pushes a new build for each gem."
 task release_all: [:update_versions, :check_locale_completeness, :webpack] do
   sh "rake release"
-  DECIDIM_GEMS.each do |gem_name|
-    Dir.chdir("#{__dir__}/decidim-#{gem_name}") do
+  DECIDIM_GEMS.each do |name|
+    Dir.chdir("#{__dir__}/decidim-#{name}") do
       sh "rake release"
     end
   end
@@ -91,6 +92,21 @@ task :check_locale_completeness do
   system({ "ENFORCED_LOCALES" => "en,ca,es" }, "rspec spec/i18n_spec.rb")
 end
 
+desc "Generates a dummy app for testing"
+task :test_app do
+  dummy_app_path = File.expand_path(File.join(Dir.pwd, "spec", "decidim_dummy_app"))
+
+  Dir.chdir(__dir__) do
+    sh "rm -fR #{dummy_app_path}", verbose: false
+  end
+
+  Bundler.with_clean_env do
+    Decidim::Generators::AppGenerator.start(
+      [dummy_app_path, "--path", "../..", "--recreate_db", "--demo"]
+    )
+  end
+end
+
 desc "Generates a development app."
 task :development_app do
   Dir.chdir(__dir__) do
@@ -106,25 +122,16 @@ end
 
 desc "Generates a development app based on Docker."
 task :docker_development_app do
-  Dir.chdir(__dir__) do
-    sh "rm -fR docker_development_app"
-  end
-
-  path = __dir__ + "/docker_development_app"
+  docker_app_path = __dir__ + "/docker_development_app"
 
   Bundler.with_clean_env do
     Decidim::Generators::DockerGenerator.start(
-      ["docker_development_app", "--path", path]
+      ["docker_development_app", "--docker_app_path", docker_app_path]
     )
   end
 end
 
 desc "Build webpack bundle files"
-task webpack: ["npm:install"] do
-  sh "npm run build:prod"
-end
-
-desc "Install npm dependencies"
-task "npm:install" do
-  sh "npm i"
+task :webpack do
+  sh "yarn install && yarn build:prod"
 end

data/docs/getting_started.md

@@ -76,20 +76,6 @@ We also have other guides on how to configure some extra features:
 - [Analytics](https://github.com/decidim/decidim/blob/master/docs/analytics.md): How to enable analytics
 - [Geocoding](https://github.com/decidim/decidim/blob/master/docs/geocoding.md): How to enable geocoding for proposals and meetings
 
-## Creating an Authorization handler
-
-Authorization handlers are used to validate users following some criteria. The most common use case is validating a user against a census, so that you can differentiate users living in your city from users living outside.
-
-The generator will have created an `ExampleAuthorizationHandler` so you can learn how to implement your own. You'll usually want to define some fields that you will use to authenticate against a census (for example, an ID and a Postal Code). In this class you'll need to write the logic to validate the user against the census. See the documentation for [the parent class](https://github.com/decidim/decidim/blob/master/decidim-core/app/services/decidim/authorization_handler.rb) and a [live example in Decidim Barcelona](https://github.com/decidim/decidim-barcelona/blob/master/app/services/census_authorization_handler.rb).
-
-You'll need to reference it from the Decidim initializer:
-
-```ruby
-# config/initializers/decidim.rb
-
-config.authorization_handlers = ["<my authorization handler class>"]
-```
-
 ## Deploy
 
 Once you've generated the Decidim app you might need to do some changes in order to deploy it. You can check [`codegram/decidim-deploy-heroku`](https://github.com/codegram/decidim-deploy-heroku) for an opinionated example of things to do before deploying to Heroku, for example.

data/docs/managing_translations_i18n.md

@@ -0,0 +1,24 @@
+# Managing translations (i18n)
+
+## The workflow
+
+Decidim uses [Crowdin](https://crowdin.com/) to manage the translations.
+
+- Whenever someone [adds a new translation key](https://github.com/decidim/decidim/pull/1814/files#diff-c78c80097da59920d55b3f462ca21afaR177) to _Decidim_, _Crowdin_ gets notified and the new content is available to be translated from [Crowdin's Decidim dashboard](https://crowdin.com/project/decidim).
+- When a translator translates any key from Crowdin, it automatically creates a [PR in Github](https://github.com/decidim/decidim/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Adecidim-bot%20Crowdin), adding the keys in the corresponding _yaml_ files.
+- 🌈
+
+## Adding a new language
+
+- Setup the new language in [_Crowdin's Decidim project_](https://crowdin.com/project/decidim) (or open an issue on Github asking an admin to do that).
+- Translate at least one key from every engine, so, your _yaml_ files are not empty. The easiest way to do this is to automatically translate and sync all the content. Later you'll be able to fix the content that wasn't properly translated.
+- Add [Foundation Datepicker](https://github.com/najlepsiwebdesigner/foundation-datepicker/tree/master/js/locales)'s translations ([PR](https://github.com/decidim/decidim/pull/2039)).
+- Add Select2 translations ([PR](https://github.com/decidim/decidim/pull/2214)).
+- Add the new language to `available_locales` ([PR](https://github.com/decidim/decidim/pull/1991)).
+- Announce the new language in the Readme ([PR](https://github.com/decidim/decidim/pull/2125)).
+
+## Test the new language
+
+- Generate the development app and `cd` into it.
+- Change the `config/initializer/decidim.rb` file and add your locale to `Decidim.available_locales`.
+- `rake db:drop db:setup` to drop, create, load schema and seed the DB.

data/docs/testing.md

@@ -5,7 +5,7 @@
 You need to create a dummy application to run your tests. Run the following command in the decidim root's folder:
 
 ```bash
-bundle exec rake decidim:generate_test_app
+bundle exec rake test_app
 ```
 
 ## Running the test suite

data/docs/view_hooks.md

@@ -0,0 +1,74 @@
+# View hooks
+
+## General description
+
+All engines can define their own view hooks, and register to other engines' ones. This allows engines to add content to views rendered by other engines. This will be clearer with an example.
+
+Take the homepage, for example. It is rendered by the `decidim-core`. We want to show there a list of highlighted participatory spaces (processes and assemblies). We cannot be sure the final app has these engines, so we need to check they exist:
+
+```
+<% if defined? Decidim::Processes %>
+  <% # iterate through the most important ones %>
+<% end %>
+<% if defined? Decidim::Assemblies %>
+  <% # iterate through the most important ones %>
+<% end %>
+```
+
+This raises two important issues:
+
+1. We are linking `decidim-core` with `decidim-assemblies` and `decidim-participatory_processes`. This is not perfect.
+1. The final app cannot extend this view to add more content in a simple way. The developers could overwrite the view, but this raises maintainability problems, as upgrades will be harder.
+
+## Rendering view hooks
+
+Instead of the previous example, we created the concept of "view hooks". Think of them as a registry of views which can be defined by a given engine and extended by others. To follow the previous example, we would register a view hook in `decidim-core`:
+
+```
+<%= Decidim.view_hooks.render(:highlighted_elements, self) %>
+```
+
+We're rendering the view hooks registered as `:highlighted_elements`. The `self` parameter is the view context, we will analyze it later.
+
+## Registering view hooks
+
+Other engines would register blocks of Ruby and Rails code from their initializers. For example, in `decidim-participatory_processes`:
+
+```ruby
+# decidim-participatory_processes/lib/decidim/participatory_processes/engine.rb
+initializer "decidim_participatory_processes.view_hooks" do
+  Decidim.view_hooks.register(:highlighted_elements) do |view_context|
+    view_context.render(partial: "my/partial")
+  end
+end
+```
+
+In order to register a view hook we need the hook name and a block of Ruby code. We're registering a view hook as `:highlighted-elements`, following our example. We're passing the view context to the block so that we can use our views helper methods there, and we're rendering a partial. We could write `ActiveRecord` queries and pass the results to the partial as `locals` if we wanted a more complex view:
+
+```ruby
+# decidim-participatory_processes/lib/decidim/participatory_processes/engine.rb
+initializer "decidim_participatory_processes.view_hooks" do
+  Decidim.view_hooks.register(:highlighted_elements) do |view_context|
+    highlighted_processes =
+      OrganizationPublishedParticipatoryProcesses.new(view_context.current_organization) | HighlightedParticipatoryProcesses.new
+
+    view_context.render(partial: "decidim/participatory_processes/my/partial", locals: { highlighted_processes: highlighted_processes })
+  end
+end
+```
+
+When registering a view hook, we can set a priority for each one. By default, all view hooks are registered with low priority, but we can change it:
+
+```ruby
+Decidim.view_hooks.register(:highlighted_elements, priority: Decidim::ViewHooks::HIGH_PRIORITY) do |view_context|
+  # ...
+end
+```
+
+## Enabling view hooks in your engine
+
+Ideally, each engine should hold their own instance of `Decidim::ViewHooks`. This means that if `decidim-participatory_processes` wants to allow part of its views to be extended by other engines, it should define `Decidim::ParticipatoryProcesses.view_hooks`, and other engines should register to this instance.
+
+## The engine I want to extend does not support view hooks, what can I do?
+
+First of all, send a PR to the engine to add the view hook you need. Expose your needs, so the developers can assess a view hook is the best solution. Sometimes a view hook can be replaced with another abstraction, or another UI. Meanwhile, you can use [`deface`](https://github.com/spree/deface) to extend a view file without replacing it. Be careful, since `deface` is *very* powerful and can be a double-edged sword. We considered adding `deface` to `decidim`, but found that it opened to a code that would be much harder to maintain.

data/lib/decidim.rb

@@ -6,6 +6,8 @@ require "decidim/admin"
 require "decidim/api"
 require "decidim/version"
 
+require "decidim/verifications"
+
 require "decidim/participatory_processes"
 
 begin

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.7.4"
+    "0.8.0"
   end
 end

data/lib/generators/decidim/app_generator.rb

@@ -79,9 +79,8 @@ module Decidim
       def gemfile
         return if options[:skip_gemfile]
 
-        path = File.expand_path(File.join("..", "..", "..", "Gemfile"), __dir__)
-
-        template path, "Gemfile", force: true
+        template path_to_root("Gemfile"), "Gemfile", force: true
+        template path_to_root("Gemfile.lock"), "Gemfile.lock", force: true
 
         gem_modifier = if options[:path]
                          "path: \"#{options[:path]}\""
@@ -94,7 +93,7 @@ module Decidim
                        end
 
         gsub_file "Gemfile", /gem "decidim([^"]*)".*/, "gem \"decidim\\1\", #{gem_modifier}"
-        run "bundle install"
+        run "BUNDLE_GEMFILE=Gemfile bundle install"
       end
 
       def add_ignore_uploads
@@ -111,17 +110,8 @@ module Decidim
       def authorization_handler
         template "initializer.rb", "config/initializers/decidim.rb"
 
-        auth_handler = if options[:demo]
-                         "decidim/dummy_authorization_handler"
-                       else
-                         "example_authorization_handler"
-                       end
-
-        template "#{auth_handler}.rb", "app/services/#{auth_handler}.rb"
-
-        gsub_file "config/initializers/decidim.rb",
-                  /config\.mailer_sender = "change-me@domain\.org"/ do |match|
-          match << "\n  config.authorization_handlers = [\"#{auth_handler.classify}\"]"
+        if options[:demo]
+          template "example_authorization_handler.rb", "app/services/example_authorization_handler.rb"
         end
       end
 
@@ -137,6 +127,10 @@ module Decidim
 
       private
 
+      def path_to_root(file)
+        File.expand_path(File.join("..", "..", "..", file), __dir__)
+      end
+
       def app_const_base
         options["app_const_base"] || super
       end

data/lib/generators/decidim/docker_generator.rb

@@ -9,10 +9,8 @@ module Decidim
     class DockerGenerator < Rails::Generators::Base
       desc "Generate a docker app for development purposes"
 
-      class_option :path, type: :string,
-                          desc: "The path to generate the docker app"
-
-      source_root File.expand_path("templates", __dir__)
+      class_option :docker_app_path, type: :string,
+                                     desc: "The path to generate the docker app"
 
       def source_paths
         [
@@ -25,19 +23,19 @@ module Decidim
       end
 
       def create_rails_app
-        Decidim::Generators::AppGenerator.start([path, "--demo"])
+        Decidim::Generators::AppGenerator.start(
+          [docker_app_path, "--path", "..", "--demo"]
+        )
       end
 
       def build_docker
-        remove_file "#{path}/Dockerfile"
-        template "Dockerfile.dev.erb", "#{path}/Dockerfile"
-        inside(path) do
+        inside(docker_app_path) do
           gsub_file "Gemfile",
-                    /gem "decidim(.*)"/,
-                    'gem "decidim", path: "/decidim"'
+                    /gem "decidim([^"]*)".*/,
+                    'gem "decidim\1", path: "/decidim"'
 
           run "docker-compose build"
-          run "docker-compose run --rm app rails db:drop db:create db:migrate db:setup"
+          run "docker-compose run --rm app rails db:drop db:create db:migrate db:seed"
         end
       end
 
@@ -50,11 +48,11 @@ module Decidim
       private
 
       def remove_directory_if_exists
-        remove_dir(path) if File.directory?(path)
+        remove_dir(docker_app_path) if File.directory?(docker_app_path)
       end
 
-      def path
-        options[:path]
+      def docker_app_path
+        options[:docker_app_path]
       end
     end
   end

data/lib/generators/decidim/install_generator.rb

@@ -49,7 +49,6 @@ module Decidim
       def append_assets
         append_file "app/assets/javascripts/application.js", "//= require decidim"
         gsub_file "app/assets/javascripts/application.js", %r{//= require turbolinks\n}, ""
-        gsub_file "app/assets/javascripts/application.js", %r{//= require rails-ujs\n}, "//= require jquery\n//= require jquery_ujs\n"
         inject_into_file "app/assets/stylesheets/application.css",
                          before: "*= require_tree ." do
           "*= require decidim\n "
@@ -106,6 +105,7 @@ module Decidim
           <<~RUBY.gsub(/^ *\|/, "")
             |
             |  config.action_mailer.delivery_method = :letter_opener_web
+            |  config.action_mailer.default_url_options = { port: 3000 }
           RUBY
         end
       end

data/lib/generators/decidim/templates/Dockerfile.erb

@@ -1 +1 @@
-FROM decidim/decidim
+FROM decidim/decidim:<%= Decidim.version %>

data/lib/generators/decidim/templates/docker-compose.yml.erb

@@ -1,7 +1,7 @@
-version: '2'
+version: '3'
 services:
   app:
-    image: decidim/decidim:0.7.2-dev 
+    image: decidim/decidim:<%= Decidim.version %>
     volumes:
       - .:/app
       - bundle:/usr/local/bundle
@@ -11,37 +11,16 @@ services:
       - DATABASE_HOST=pg
       - DATABASE_USERNAME=postgres
       - RAILS_ENV=development
-      - REDIS_URL=redis://redis:6379
     ports:
       - 3000:3000
     links:
       - pg
-      - redis
     command: bundle exec puma
-  worker:
-    image: decidim/decidim:latest-dev
-    volumes:
-      - .:/app
-      - bundle:/usr/local/bundle
-    environment:
-      - DATABASE_HOST=pg
-      - DATABASE_USERNAME=postgres
-      - RAILS_ENV=development
-      - REDIS_URL=redis://redis:6379
-    links:
-      - pg
-      - redis
-    command: bundle exec sidekiq
   pg:
     image: postgres
     volumes:
       - pg-data:/var/lib/postgresql/data
-  redis:
-    image: redis
-    volumes:
-      - redis-data:/data
 volumes:
   node_modules: {}
   bundle: {}
   pg-data: {}
-  redis-data: {}