decidim-generators 0.22.0 → 0.23.3

data/lib/decidim/generators/app_generator.rb

@@ -61,6 +61,10 @@ module Decidim
                           default: false,
                           desc: "Generate demo authorization handlers"
 
+      class_option :profiling, type: :boolean,
+                               default: false,
+                               desc: "Add the necessary gems to profile the app"
+
       def database_yml
         template "database.yml.erb", "config/database.yml", force: true
       end
@@ -111,7 +115,7 @@ module Decidim
         if current_gem == "decidim"
           gsub_file "Gemfile", /gem "decidim-dev".*/, "gem \"decidim-dev\", #{gem_modifier}"
 
-          %w(conferences consultations elections initiatives).each do |component|
+          %w(conferences consultations elections initiatives templates).each do |component|
             if options[:demo]
               gsub_file "Gemfile", /gem "decidim-#{component}".*/, "gem \"decidim-#{component}\", #{gem_modifier}"
             else
@@ -170,6 +174,15 @@ module Decidim
                   "config.sms_gateway_service = 'Decidim::Verifications::Sms::ExampleGateway'"
       end
 
+      def budgets_workflows
+        return unless options[:demo]
+
+        copy_file "budgets_workflow_random.rb", "lib/budgets_workflow_random.rb"
+        copy_file "budgets_workflow_random.en.yml", "config/locales/budgets_workflow_random.en.yml"
+
+        copy_file "budgets_initializer.rb", "config/initializers/decidim_budgets.rb"
+      end
+
       def timestamp_service
         return unless options[:demo]
 
@@ -186,13 +199,22 @@ module Decidim
                   "config.pdf_signature_service = \"Decidim::Initiatives::PdfSignatureExample\""
       end
 
+      def machine_translation_service
+        return unless options[:demo]
+
+        gsub_file "config/initializers/decidim.rb",
+                  /# config.machine_translation_service = \"MyTranslationService\"/,
+                  "config.machine_translation_service = 'Decidim::Dev::DummyTranslator'"
+      end
+
       def install
         Decidim::Generators::InstallGenerator.start(
           [
             "--recreate_db=#{options[:recreate_db]}",
             "--seed_db=#{options[:seed_db]}",
             "--skip_gemfile=#{options[:skip_gemfile]}",
-            "--app_name=#{app_name}"
+            "--app_name=#{app_name}",
+            "--profiling=#{options[:profiling]}"
           ]
         )
       end

data/lib/decidim/generators/app_templates/budgets_initializer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "budgets_workflow_random"
+Decidim::Budgets.workflows[:random] = BudgetsWorkflowRandom

data/lib/decidim/generators/app_templates/budgets_workflow_random.en.yml

@@ -0,0 +1,8 @@
+en:
+  decidim:
+    components:
+      budgets:
+        settings:
+          global:
+            workflow_choices:
+              random: "Vote in a random component: allows participants to vote only in one budget, selected randomly."

data/lib/decidim/generators/app_templates/budgets_workflow_random.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# This Workflow allows users to vote only in one budget, selected randomly.
+#
+# Note: random selection should be deterministic for the same user and the same budgets component.
+# As the budget resources list could change and affect the random selection, it also allows to finish orders created on other budgets.
+class BudgetsWorkflowRandom < Decidim::Budgets::Workflows::Base
+  # Highlight the resource if the user didn't vote and is allowed to vote on it.
+  def highlighted?(resource)
+    vote_allowed?(resource)
+  end
+
+  # User can vote in the resource where they have an order in progress or in the randomly selected resource.
+  def vote_allowed?(resource, consider_progress = true)
+    return false if voted.any?
+
+    if consider_progress
+      progress?(resource) || (progress.none? && resource == random_resource)
+    else
+      resource == random_resource
+    end
+  end
+
+  def discardable
+    []
+  end
+
+  private
+
+  def random_resource
+    @random_resource ||= budgets.reorder(id: :asc).to_a[user.id % budgets.count] if user
+  end
+end

data/lib/decidim/generators/app_templates/bullet_initializer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+if defined?(Bullet)
+  Rails.application.config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+    Bullet.stacktrace_includes = %w(decidim-)
+  end
+end

data/lib/decidim/generators/app_templates/dummy_authorization_handler.rb

@@ -23,9 +23,11 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
   # Define the attributes you need for this authorization handler. Attributes
   # are defined using Virtus.
   #
+  attribute :name_and_surname, String
   attribute :document_number, String
   attribute :postal_code, String
   attribute :birthday, Decidim::Attributes::LocalizedDate
+  attribute :scope_id, Integer
 
   # You can (and should) also define validations on each attribute:
   #
@@ -34,6 +36,7 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
   # You can also define custom validations:
   #
   validate :valid_document_number
+  validate :valid_scope_id
 
   # The only method that needs to be implemented for an authorization handler.
   # Here you can add your business logic to check if the authorization should
@@ -53,6 +56,12 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
     document_number
   end
 
+  # The user scope
+  #
+  def scope
+    user.organization.scopes.find_by(id: scope_id) if scope_id
+  end
+
   # If you need to store any of the defined attributes in the authorization you
   # can do it here.
   #
@@ -60,7 +69,7 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
   # it's created, and available though authorization.metadata
   #
   def metadata
-    super.merge(document_number: document_number, postal_code: postal_code)
+    super.merge(document_number: document_number, postal_code: postal_code, scope_id: scope_id)
   end
 
   private
@@ -69,19 +78,25 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
     errors.add(:document_number, :invalid) unless document_number.to_s.end_with?("X")
   end
 
+  def valid_scope_id
+    errors.add(:scope_id, :invalid) if scope_id && !scope
+  end
+
   # If you need custom authorization logic, you can implement your own action
   # authorizer. In this case, it allows to set a list of valid postal codes for
   # an authorization.
   class DummyActionAuthorizer < Decidim::Verifications::DefaultActionAuthorizer
-    attr_reader :allowed_postal_codes
+    attr_reader :allowed_postal_codes, :allowed_scope_id
 
     # Overrides the parent class method, but it still uses it to keep the base behavior
     def authorize
       # Remove the additional setting from the options hash to avoid to be considered missing.
-      @allowed_postal_codes ||= options.delete("allowed_postal_codes")
+      @allowed_postal_codes ||= options.delete("allowed_postal_codes")&.split(/[\W,;]+/)
+      @allowed_scope_id ||= options.delete("allowed_scope_id")&.to_i
 
       status_code, data = *super
 
+      extra_explanations = []
       if allowed_postal_codes.present?
         # Does not authorize users with different postal codes
         if status_code == :ok && !allowed_postal_codes.member?(authorization.metadata["postal_code"])
@@ -90,18 +105,47 @@ class DummyAuthorizationHandler < Decidim::AuthorizationHandler
         end
 
         # Adds an extra message for inform the user the additional restriction for this authorization
-        data[:extra_explanation] = { key: "extra_explanation",
-                                     params: { scope: "decidim.verifications.dummy_authorization",
-                                               count: allowed_postal_codes.count,
-                                               postal_codes: allowed_postal_codes.join(", ") } }
+        extra_explanations << { key: "extra_explanation.postal_codes",
+                                params: { scope: "decidim.verifications.dummy_authorization",
+                                          count: allowed_postal_codes.count,
+                                          postal_codes: allowed_postal_codes.join(", ") } }
+      end
+
+      if allowed_scope.present?
+        # Does not authorize users with different scope
+        if status_code == :ok && allowed_scope_id != user_scope_id
+          status_code = :unauthorized
+          data[:fields] = { "scope_id" => user_scope.name[I18n.locale.to_s] }
+        end
+
+        # Adds an extra message to inform the user about additional restrictions for this authorization
+        extra_explanations << { key: "extra_explanation.scope",
+                                params: { scope: "decidim.verifications.dummy_authorization",
+                                          scope_name: allowed_scope.name[I18n.locale.to_s] } }
       end
 
+      data[:extra_explanation] = extra_explanations if extra_explanations.any?
+
       [status_code, data]
     end
 
-    # Adds the list of allowed postal codes to the redirect URL, to allow forms to inform about it
+    # Adds the list of allowed postal codes and scope to the redirect URL, to allow forms to inform about it
     def redirect_params
-      { "postal_codes" => allowed_postal_codes&.join("-") }
+      { "postal_codes" => allowed_postal_codes&.join(","), "scope" => allowed_scope_id }
+    end
+
+    private
+
+    def allowed_scope
+      @allowed_scope ||= Decidim::Scope.find(allowed_scope_id) if allowed_scope_id
+    end
+
+    def user_scope
+      @user_scope ||= Decidim::Scope.find(user_scope_id) if user_scope_id
+    end
+
+    def user_scope_id
+      @user_scope_id ||= authorization.metadata["scope_id"]&.to_i
     end
   end
 end

data/lib/decidim/generators/app_templates/initializer.rb

@@ -5,7 +5,7 @@ Decidim.configure do |config|
   config.application_name = "My Application Name"
 
   # The email that will be used as sender in all emails from Decidim
-  config.mailer_sender = "change-me@domain.org"
+  config.mailer_sender = "change-me@example.org"
 
   # Sets the list of available locales for the whole application.
   #
@@ -14,16 +14,16 @@ Decidim.configure do |config|
   # of languages will be equal or a subset of the list in this file.
   config.available_locales = [:en, :ca, :es]
 
-  # Restrict access to the system part with an authorized ip list.
-  # You can use a single ip like ("1.2.3.4"), or an ip subnet like ("1.2.3.4/24")
-  # You may specify multiple ip in an array ["1.2.3.4", "1.2.3.4/24"]
-  # config.system_accesslist_ips = ["127.0.0.1"]
-
   # Sets the default locale for new organizations. When creating a new
   # organization from the System area, system admins will be able to overwrite
   # this value for that specific organization.
   config.default_locale = :en
 
+  # Restrict access to the system part with an authorized ip list.
+  # You can use a single ip like ("1.2.3.4"), or an ip subnet like ("1.2.3.4/24")
+  # You may specify multiple ip in an array ["1.2.3.4", "1.2.3.4/24"]
+  # config.system_accesslist_ips = ["127.0.0.1"]
+
   # Defines a list of custom content processors. They are used to parse and
   # render specific tags inside some user-provided content. Check the docs for
   # more info.
@@ -32,10 +32,71 @@ Decidim.configure do |config|
   # Whether SSL should be enabled or not.
   # config.force_ssl = true
 
-  # Geocoder configuration
+  # Map and Geocoder configuration
+  #
+  # == HERE Maps ==
+  # config.maps = {
+  #   provider: :here,
+  #   api_key: Rails.application.secrets.maps[:api_key],
+  #   static: { url: "https://image.maps.ls.hereapi.com/mia/1.6/mapview" }
+  # }
+  #
+  # == OpenStreetMap (OSM) services ==
+  # To use the OSM map service providers, you will need a service provider for
+  # the following map servers or host all of them yourself:
+  # - A tile server for the dynamic maps
+  #   (https://wiki.openstreetmap.org/wiki/Tile_servers)
+  # - A Nominatim geocoding server for the geocoding functionality
+  #   (https://wiki.openstreetmap.org/wiki/Nominatim)
+  # - A static map server for static map images
+  #   (https://github.com/jperelli/osm-static-maps)
+  #
+  # When used, please read carefully the terms of service for your service
+  # provider.
+  #
+  # config.maps = {
+  #   provider: :osm,
+  #   api_key: Rails.application.secrets.maps[:api_key],
+  #   dynamic: {
+  #     tile_layer: {
+  #       url: "https://tiles.example.org/{z}/{x}/{y}.png?key={apiKey}&{foo}",
+  #       api_key: true,
+  #       foo: "bar=baz",
+  #       attribution: %(
+  #         <a href="https://www.openstreetmap.org/copyright" target="_blank">&copy; OpenStreetMap</a> contributors
+  #       ).strip
+  #       # Translatable attribution:
+  #       # attribution: -> { I18n.t("tile_layer_attribution") }
+  #     }
+  #   },
+  #   static: { url: "https://staticmap.example.org/" },
+  #   geocoding: { host: "nominatim.example.org", use_https: true }
+  # }
+  #
+  # == Combination (OpenStreetMap default + HERE Maps dynamic map tiles) ==
+  # config.maps = {
+  #   provider: :osm,
+  #   api_key: Rails.application.secrets.maps[:api_key],
+  #   dynamic: {
+  #     provider: :here,
+  #     api_key: Rails.application.secrets.maps[:here_api_key]
+  #   },
+  #   static: { url: "https://staticmap.example.org/" },
+  #   geocoding: { host: "nominatim.example.org", use_https: true }
+  # }
+
+  # Geocoder configurations if you want to customize the default geocoding
+  # settings. The maps configuration will manage which geocoding service to use,
+  # so that does not need any additional configuration here. Use this only for
+  # the global geocoder preferences.
   # config.geocoder = {
-  #   static_map_url: "https://image.maps.ls.hereapi.com/mia/1.6/mapview",
-  #   here_api_key: Rails.application.secrets.geocoder[:here_api_key]
+  #   # geocoding service request timeout, in seconds (default 3):
+  #   timeout: 5,
+  #   # set default units to kilometers:
+  #   units: :km,
+  #   # caching (see https://github.com/alexreisner/geocoder#caching for details):
+  #   cache: Redis.new,
+  #   cache_prefix: "..."
   # }
 
   # Custom resource reference generator method. Check the docs for more info.
@@ -51,12 +112,6 @@ Decidim.configure do |config|
   # processed by Decidim, this value helps reduce the size of the files.
   # config.image_uploader_quality = 80
 
-  # The maximum file size of an attachment
-  # config.maximum_attachment_size = 10.megabytes
-
-  # The maximum file size for a user avatar
-  # config.maximum_avatar_size = 10.megabytes
-
   # The number of reports which a resource can receive before hiding it
   # config.max_reports_before_hiding = 3
 
@@ -90,13 +145,6 @@ Decidim.configure do |config|
   # Time window were users can access the website even if their email is not confirmed.
   # config.unconfirmed_access_for = 2.days
 
-  # Etherpad configuration. Check the docs for more info.
-  # config.etherpad = {
-  #   server: <your url>,
-  #   api_key: <your key>,
-  #   api_version: <your version>
-  # }
-
   # A base path for the uploads. If set, make sure it ends in a slash.
   # Uploads will be set to `<base_path>/uploads/`. This can be useful if you
   # want to use the same uploads place for both staging and production
@@ -200,6 +248,36 @@ Decidim.configure do |config|
   # radio buttons collection input field form for a Decidim::Component
   # step setting :amendments_visibility.
   # config.amendments_visibility_options = %w(all participants)
+
+  # Machine Translation Configuration
+  #
+  # Enable machine translations
+  config.enable_machine_translations = false
+  #
+  # If you want to enable machine translation you can create your own service
+  # to interact with third party service to translate the user content.
+  #
+  # An example class would be something like:
+  #
+  # class MyTranslationService
+  #   attr_reader :text, :original_locale, :target_locale
+  #
+  #   def initialize(text, original_locale, target_locale)
+  #     @text = text
+  #     @original_locale = original_locale
+  #     @target_locale = target_locale
+  #   end
+  #
+  #   def translate
+  #     # Actual code to translate the text
+  #   end
+  # end
+  #
+  # config.machine_translation_service = "MyTranslationService"
+
+  # Defines the name of the cookie used to check if the user allows Decidim to
+  # set cookies.
+  # config.consent_cookie_name = "decidim-cc"
 end
 
 Rails.application.config.i18n.available_locales = Decidim.available_locales

data/lib/decidim/generators/app_templates/rack_profiler_initializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+if Rails.env.development?
+  require "rack-mini-profiler"
+
+  # initialization is skipped so trigger it
+  Rack::MiniProfilerRails.initialize!(Rails.application)
+end

data/lib/decidim/generators/app_templates/secrets.yml.erb

@@ -26,12 +26,17 @@ default: &default
       icon_path: decidim/brands/google.svg
       client_id: <%%= ENV["OMNIAUTH_GOOGLE_CLIENT_ID"] %>
       client_secret: <%%= ENV["OMNIAUTH_GOOGLE_CLIENT_SECRET"] %>
-  geocoder:
-    here_api_key: <%%= ENV["GEOCODER_API_KEY"] %>
+  maps:
+    api_key: <%%= ENV["MAPS_API_KEY"] %>
   etherpad:
     server: <%%= ENV["ETHERPAD_SERVER"] %>
     api_key: <%%= ENV["ETHERPAD_API_KEY"] %>
     api_version: "1.2.1"
+  bulletin_board:
+    identification_private_key: |
+<%= ENV["BULLETIN_BOARD_IDENTIFICATION_PRIVATE_KEY"]&.indent(6) %>
+    server: <%= ENV["BULLETIN_BOARD_SERVER"] %>
+    api_key: <%= ENV["BULLETIN_BOARD_API_KEY"] %>
 
 development:
   <<: *default

data/lib/decidim/generators/app_templates/verifications_initializer.rb

@@ -3,18 +3,19 @@
 Decidim::Verifications.register_workflow(:dummy_authorization_handler) do |workflow|
   workflow.form = "DummyAuthorizationHandler"
   workflow.action_authorizer = "DummyAuthorizationHandler::DummyActionAuthorizer"
-  workflow.expires_in = 1.hour
+  workflow.expires_in = 1.month
   workflow.renewable = true
   workflow.time_between_renewals = 5.minutes
 
   workflow.options do |options|
-    options.attribute :postal_code, type: :string, default: "08001", required: false
+    options.attribute :allowed_postal_codes, type: :string, default: "08001", required: false
+    options.attribute :allowed_scope_id, type: :scope, required: false
   end
 end
 
 Decidim::Verifications.register_workflow(:another_dummy_authorization_handler) do |workflow|
   workflow.form = "AnotherDummyAuthorizationHandler"
-  workflow.expires_in = 1.hour
+  workflow.expires_in = 1.month
 
   workflow.options do |options|
     options.attribute :passport_number, type: :string, required: false