decidim-core 0.26.4 → 0.27.0.rc1

data/lib/decidim/reminder_registry.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a registry for reminders. Each reminder needs a name,
+  # and a generator class, that will be used for generating the actual sendable reminders.
+  # Reminder times could be used to define intervals between reminders, so that user
+  # isn't reminded too often. In addition, you can register form and command classes
+  # for additional features, such as order reminders can be sent manually from the admin panel.
+  # Notice that if you implement admin panel functionality, you should add 118n messages too.
+  #
+  # In order to register a reminder, you can follow this example:
+  #
+  #     Decidim.reminders_registry.register(:orders) do |reminder_registry|
+  #       reminder_registry.generator_class_name = "Decidim::Budgets::OrderReminderGenerator"
+  #       reminder_registry.form_class_name = "Decidim::Budgets::Admin::OrderReminderForm"
+  #       reminder_registry.command_class_name = "Decidim::Budgets::Admin::CreateOrderReminders"
+  #
+  #       reminder_registry.settings do |settings|
+  #         settings.attribute :reminder_times, type: :array, default: [2.hours, 1.week, 2.weeks]
+  #       end
+  #
+  #       reminder_registry.messages do |msg|
+  #         msg.set(:title) { |count: 0| I18n.t("decidim.budgets.admin.reminders.orders.title", count: count) }
+  #         msg.set(:description) { I18n.t("decidim.budgets.admin.reminders.orders.description") }
+  #       end
+  #     end
+  #
+  # Reminders need to be registered in the `engine.rb` file of each module.
+  class ReminderRegistry
+    def register(reminder_name)
+      reminder_name = reminder_name.to_s
+      if reminder_exists?(reminder_name)
+        raise(
+          ReminderAlreadyRegistered,
+          "There's a reminder already registered with the name `:#{reminder_name}`, must be unique"
+        )
+      end
+
+      reminder_manifest = ::Decidim::ReminderManifest.new(name: reminder_name)
+      yield(reminder_manifest)
+      reminder_manifest.validate!
+
+      reminder_manifests << reminder_manifest
+    end
+
+    def for(reminder_name, list = nil)
+      list ||= all
+      list.find { |manifest| manifest.name == reminder_name.to_s }
+    end
+
+    def all
+      reminder_manifests
+    end
+
+    class ReminderAlreadyRegistered < StandardError; end
+
+    private
+
+    def reminder_exists?(reminder_name)
+      self.for(reminder_name).present?
+    end
+
+    def reminder_manifests
+      @reminder_manifests ||= []
+    end
+  end
+end

data/lib/decidim/resource_manifest.rb

@@ -15,7 +15,7 @@ module Decidim
   #
   class ResourceManifest
     include ActiveModel::Model
-    include Virtus.model
+    include Decidim::AttributeObject::Model
 
     # The name of the resource we are exposing.
     attribute :name, String

data/lib/decidim/resourceable.rb

@@ -18,6 +18,17 @@ module Decidim
       # An association with the permissions settings for the resource
       has_one :resource_permission, as: :resource, class_name: "Decidim::ResourcePermission"
 
+      scope :related_to, lambda { |related_to_key|
+        from = joins(:resource_links_from).where(
+          decidim_resource_links: { to_type: related_to_key.camelcase }
+        )
+        to = joins(:resource_links_to).where(
+          decidim_resource_links: { from_type: related_to_key.camelcase }
+        )
+
+        where(id: from).or(where(id: to))
+      }
+
       # Finds all the linked resources to or from this model for a given resource
       # name and link name.
       #
@@ -25,8 +36,8 @@ module Decidim
       # link_name     - The String name of the link between this model and the target resource.
       #
       # Returns an ActiveRecord::Relation.
-      def linked_resources(resource_name, link_name, component_published: true)
-        scope = sibling_scope(resource_name, component_published: component_published)
+      def linked_resources(resource_name, link_name)
+        scope = sibling_scope(resource_name)
 
         from = scope
                .joins(:resource_links_from)
@@ -45,15 +56,14 @@ module Decidim
       # resource_name - The String name of the resource manifest exposed by a component.
       #
       # Returns an ActiveRecord::Relation.
-      def sibling_scope(resource_name, component_published: true)
+      def sibling_scope(resource_name)
         manifest = Decidim.find_resource_manifest(resource_name)
         return self.class.none unless manifest
 
         scope = manifest.resource_scope(component)
         scope = scope.where("#{self.class.table_name}.id != ?", id) if manifest.model_class == self.class
         scope = scope.not_hidden if manifest.model_class.respond_to?(:not_hidden)
-        scope = scope.includes(:component).where.not(decidim_components: { published_at: nil }) if component_published
-        scope
+        scope.includes(:component).where.not(decidim_components: { published_at: nil })
       end
 
       # Links the given resources to this model, replaces any previous links with the same name.

data/lib/decidim/scopable.rb

@@ -26,6 +26,21 @@ module Decidim
       delegate :scopes, to: :organization
 
       validate :scope_belongs_to_organization
+
+      scope :with_scope, ->(scope_id) { includes(:scope).references(:decidim_scopes).where("? = ANY(decidim_scopes.part_of)", scope_id) }
+
+      scope :with_any_scope, lambda { |*original_scope_ids|
+        scope_ids = original_scope_ids.flatten
+        return self if scope_ids.include?("all")
+
+        clean_scope_ids = scope_ids
+
+        conditions = []
+        conditions << "#{table_name}.decidim_scope_id IS NULL" if clean_scope_ids.delete("global")
+        conditions.concat(["? = ANY(decidim_scopes.part_of)"] * clean_scope_ids.count) if clean_scope_ids.any?
+
+        includes(:scope).references(:decidim_scopes).where(Arel.sql(conditions.join(" OR ")).to_s, *clean_scope_ids.map(&:to_i))
+      }
     end
 
     # Whether the resource has scopes enabled or not.

data/lib/decidim/settings_manifest.rb

@@ -38,14 +38,14 @@ module Decidim
       manifest = self
 
       @schema = Class.new do
-        include Virtus.model
+        include Decidim::AttributeObject::Model
         include ActiveModel::Validations
         include TranslatableAttributes
 
         cattr_accessor :manifest
         attr_reader :default_locale
 
-        # Overwrites Virtus::InstanceMethods::Constructor#initialize to allow
+        # Overwrites Decidim::AttributeObject::Model#initialize to allow
         # passing a default_locale needed to validate translatable attributes.
         # See TranslatablePresenceValidator#default_locale_for(record).
         def initialize(attributes = nil, default_locale = nil)
@@ -85,7 +85,7 @@ module Decidim
     # to encapsulate behavior related to each individual settings field. Shouldn't
     # be used from the outside.
     class Attribute
-      include Virtus.model
+      include Decidim::AttributeObject::Model
       include ActiveModel::Validations
 
       TYPES = {
@@ -97,7 +97,7 @@ module Decidim
         enum: { klass: String, default: nil },
         select: { klass: String, default: nil },
         scope: { klass: Integer, default: nil },
-        time: { klass: Decidim::Attributes::TimeWithZone, default: nil }
+        time: { klass: DateTime, default: nil }
       }.freeze
 
       attribute :type, Symbol, default: :boolean

data/lib/decidim/spring.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A special Spring watcher for Decidim to ignore specific paths from the
+  # watching causing excessive use of inodes, issues with CPU usage and with
+  # startup/stop. This should be loaded at the application's config/spring.rb
+  # file.
+  module SpringWatcher
+    def start
+      super
+      listener.ignore(/^(node_modules|storage|tmp)/)
+    end
+  end
+end
+
+Spring::Watcher::Listen.prepend Decidim::SpringWatcher

data/lib/decidim/translatable_attributes.rb

@@ -4,13 +4,13 @@ require "active_support/concern"
 
 module Decidim
   # A set of convenience methods to deal with I18n attributes and validations
-  # in a way that's compatible with Virtus and ActiveModel, thus making it easy
-  # to integrate into Rails' forms and similar workflows.
+  # in a way that's compatible with AttributeObject and ActiveModel, thus making
+  # it easy to integrate into Rails' forms and similar workflows.
   module TranslatableAttributes
     extend ActiveSupport::Concern
 
     class_methods do
-      # Public: Mirrors Virtus' `attribute` interface to define attributes in
+      # Public: Mirrors the `attribute` interface to define attributes in
       # multiple locales.
       #
       # name - The attribute's name
@@ -34,29 +34,26 @@ module Decidim
       #   end
       #
       # Returns nothing.
-      def translatable_attribute(name, type, *options)
-        attribute name, Hash, default: {}
+      def translatable_attribute(name, type, **options)
+        attribute(name, { String => Object }, default: {})
 
         locales.each do |locale|
           attribute_name = "#{name}_#{locale}".gsub("-", "__")
-          attribute attribute_name, type, *options
+          attribute attribute_name, type, **options
 
           define_method attribute_name do
             field = public_send(name) || {}
-            value =
-              if field.is_a?(Hash)
-                field[locale.to_s] || field[locale.to_sym]
-              else
-                # The value may not be a hash in case the attribute type was
-                # changed and the old value is still stored against the record.
-                field
-              end
-            attribute_set[attribute_name].coerce(value)
+            value = field[locale.to_s] || field[locale.to_sym]
+            value_type = self.class.attribute_types[attribute_name.to_s]
+            value_type ? value_type.cast(value) : value
           end
 
           define_method "#{attribute_name}=" do |value|
             field = public_send(name) || {}
-            public_send("#{name}=", field.merge(locale => super(value)))
+            final = super(value)
+            return unless final # Do not set the `nil` values for the parent hash
+
+            public_send("#{name}=", field.merge(locale => final))
           end
 
           yield(attribute_name, locale) if block_given?

data/lib/decidim/url_option_resolver.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A class for resolving the default URL options.
+  class UrlOptionResolver
+    def options
+      {}.tap do |opts|
+        opts[:host] = host if host
+        opts[:port] = port unless default_port?
+        opts[:protocol] = protocol if protocol == "https"
+      end
+    end
+
+    def protocol
+      return "https" if Rails.application.config.force_ssl || port == 443
+
+      "http"
+    end
+
+    def host
+      @host ||= begin
+        default_host = nil
+        default_host = "localhost" if Rails.env.development? || Rails.env.test?
+
+        ENV.fetch("HOSTNAME", default_host)
+      end
+    end
+
+    def port
+      @port ||= begin
+        default_port =
+          if Rails.env.development?
+            3000
+          elsif Rails.env.test?
+            Capybara.server_port
+          elsif Rails.application.config.force_ssl
+            443
+          else
+            80
+          end
+
+        ENV.fetch("PORT", default_port).to_i
+      end
+    end
+
+    def default_port?
+      [443, 80].include?(port)
+    end
+  end
+end

data/lib/decidim/view_hooks.rb

@@ -77,7 +77,7 @@ module Decidim
     def render(name, view_context)
       hooks[name].map do |hook|
         hook.render(view_context)
-      end.join("").html_safe
+      end.join.html_safe
     end
 
     private

data/lib/decidim/view_model.rb

@@ -19,7 +19,7 @@ module Decidim
 
     delegate :current_organization, to: :controller
 
-    cache :show, if: :perform_caching? do
+    cache :show, if: :perform_caching?, expires_in: :cache_expiry_time do
       cache_hash
     end
 
@@ -60,6 +60,10 @@ module Decidim
       nil
     end
 
+    def cache_expiry_time
+      nil
+    end
+
     def decidim
       Decidim::Core::Engine.routes.url_helpers
     end

data/lib/decidim/webpacker/thread_safe_compiler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This fixes a thread safety issue with the Webpacker compiler explained here:
+# https://github.com/rails/webpacker/issues/2801
+#
+# The fix is partly from the issue and partly from this commit at Shakapacker:
+# https://github.com/shakacode/shakapacker/commit/f2dc437ecd9914f394780d4c3150fc4a70d40f9d
+
+require "webpacker/compiler"
+
+module Decidim
+  module Webpacker
+    module ThreadSafeCompiler
+      private
+
+      def watched_files_digest
+        warn "Webpacker::Compiler.watched_paths has been deprecated. Set additional_paths in webpacker.yml instead." unless watched_paths.empty?
+        root_path = Pathname.new(File.expand_path(config.root_path))
+        expanded_paths = [*default_watched_paths, *watched_paths].map do |path|
+          root_path.join(path)
+        end
+        files = Dir[*expanded_paths].reject { |f| File.directory?(f) }
+        file_ids = files.sort.map { |f| "#{File.basename(f)}/#{Digest::SHA1.file(f).hexdigest}" }
+        Digest::SHA1.hexdigest(file_ids.join("/"))
+      end
+    end
+  end
+end
+
+Webpacker::Compiler.prepend(Decidim::Webpacker::ThreadSafeCompiler)

data/lib/decidim/webpacker/webpack/custom.js

@@ -1,7 +1,6 @@
 /* eslint-disable */
-
-const path = require("path");
 const { config } = require("@rails/webpacker");
+const { InjectManifest } = require("workbox-webpack-plugin");
 
 module.exports = {
   module: {
@@ -93,5 +92,18 @@ module.exports = {
   optimization: {
     runtimeChunk: false
   },
-  entry: config.entrypoints
+  entry: config.entrypoints,
+  plugins: [
+    new InjectManifest({
+      swSrc: "src/decidim/sw/sw.js",
+
+      /**
+       * NOTE:
+       * @rails/webpacker outputs to '/packs',
+       * in order to make the SW run properly
+       * they must be put at the project's root folder '/'
+       */
+      swDest: "../sw.js"
+    })
+  ]
 }

data/lib/decidim/webpacker/webpacker.yml

@@ -33,7 +33,7 @@ development:
     hmr: false
     client:
       # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
-      overlay: true
+      overlay: false
       # May also be a string
       # webSocketURL:
       #  hostname: "0.0.0.0"

data/lib/decidim/webpacker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "decidim/webpacker/thread_safe_compiler"
+
 module Decidim
   module Webpacker
     autoload :Configuration, "decidim/webpacker/configuration"

data/lib/devise/models/decidim_validatable.rb

@@ -37,7 +37,7 @@ module Devise
         end
       end
 
-      def self.assert_validations_api!(base) #:nodoc:
+      def self.assert_validations_api!(base) # :nodoc:
         unavailable_validations = VALIDATIONS.reject { |v| base.respond_to?(v) }
 
         unless unavailable_validations.empty?

data/lib/tasks/decidim_active_storage_migration_tasks.rake

@@ -21,9 +21,7 @@ namespace :decidim do
       path = Rails.root.join("tmp/attachment_mappings.csv")
       dirname = File.dirname(path)
       FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-      File.open(path, "wb") do |file|
-        file.write(Decidim::Exporters::CSV.new(routes_mappings).export.read)
-      end
+      File.binwrite(path, Decidim::Exporters::CSV.new(routes_mappings).export.read)
     end
 
     desc "Checks attachments migrated from Carrierwave to ActiveStorage"

data/lib/tasks/{decidim_data_portability_tasks.rake → decidim_download_your_data_tasks.rake}

@@ -55,7 +55,7 @@ namespace :decidim do
     end
   end
 
-  desc "Check and notify users to update her newsletter notifications settings"
+  desc "Check and notify users to update their newsletter notifications settings"
   task check_users_newsletter_opt_in: :environment do
     print %(
 > This will send an email to all the users that have marked the newsletter by default. This should only be run if you were using Decidim before v0.11
@@ -70,22 +70,22 @@ namespace :decidim do
     end
   end
 
-  desc "Deletes all data portability files previous to `Decidim.data_portability_expiry_time` from now."
-  task delete_data_portability_files: :environment do
-    puts "DELETE DATA PORTABILITY FILES: -------------- START"
+  desc "Deletes all download your data files previous to `Decidim.download_your_data_expiry_time` from now."
+  task delete_download_your_data_files: :environment do
+    puts "DELETE DOWNLOAD YOUR DATA FILES: -------------- START"
     attachments = ActiveStorage::Attachment.joins(:blob).where(
-      name: "data_portability_file",
+      name: "download_your_data_file",
       record_type: "Decidim::UserBaseEntity"
     ).where(
-      "active_storage_blobs.created_at < ?", Decidim.data_portability_expiry_time.ago
+      "active_storage_blobs.created_at < ?", Decidim.download_your_data_expiry_time.ago
     )
     attachments.each do |attachment|
-      delete_data_portability_file attachment
+      delete_download_your_data_file attachment
     end
-    puts "DELETE DATA PORTABILITY FILES: --------------- END"
+    puts "DELETE DOWNLOAD YOUR DATA FILES: --------------- END"
   end
 
-  def delete_data_portability_file(attachment)
+  def delete_download_your_data_file(attachment)
     puts "------"
     puts "!! deleting: #{attachment.filename}"
     attachment.purge

data/lib/tasks/decidim_mailers_tasks.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :mailers do
+    desc "Task to send the notification digest email with the daily report"
+    task notifications_digest_daily: :environment do
+      notifications_digest(:daily)
+    end
+
+    desc "Task to send the notification digest email with the weekly report"
+    task notifications_digest_weekly: :environment do
+      notifications_digest(:weekly)
+    end
+  end
+
+  def notifications_digest(frequency)
+    target_users = Decidim::User.where(notifications_sending_frequency: frequency)
+    time = Time.now.utc
+    target_users.find_each do |user|
+      Decidim::EmailNotificationsDigestGeneratorJob.perform_later(user.id, frequency, time: time)
+    end
+  end
+end

data/lib/tasks/decidim_metrics_tasks.rake

@@ -4,7 +4,7 @@ namespace :decidim do
   namespace :metrics do
     # All ------
     #
-    # Get all metrics entities and execute his own rake task.
+    # Get all metrics entities and execute its own rake task.
     # It admits a date-string parameter, in a 'YYYY-MM-DD' format from
     # today to all past dates
     desc "Execute all metrics calculation methods"

data/lib/tasks/decidim_pwa_tasks.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "webpush"
+
+namespace :decidim do
+  namespace :pwa do
+    desc "Generates VAPID keys for push notifications"
+    task :generate_vapid_keys do
+      vapid_key = Webpush.generate_key
+
+      puts("VAPID keys correctly generated.")
+      puts("*******************************")
+      puts("You have to set the following env vars:\n\n")
+      puts("VAPID_PUBLIC_KEY=#{vapid_key.public_key}")
+      puts("VAPID_PRIVATE_KEY=#{vapid_key.private_key}")
+    end
+  end
+end

data/lib/tasks/decidim_reminders_tasks.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :reminders do
+    task :all, [] => :environment do
+      Decidim.reminders_registry.all.each do |reminder_manifest|
+        call_reminder_job(reminder_manifest)
+      end
+    end
+  end
+
+  def call_reminder_job(reminder_manifest)
+    Decidim::ReminderGeneratorJob.perform_later(
+      reminder_manifest.generator_class_name
+    )
+  end
+end

data/lib/tasks/decidim_tasks.rake

@@ -2,7 +2,12 @@
 
 namespace :decidim do
   desc "Install migrations from Decidim to the app."
-  task upgrade: [:choose_target_plugins, :"railties:install:migrations", :"decidim:webpacker:upgrade"]
+  task upgrade: [
+    :choose_target_plugins,
+    :"railties:install:migrations",
+    :"decidim:webpacker:upgrade",
+    :"decidim_api:generate_docs"
+  ]
 
   desc "Setup environment so that only decidim migrations are installed."
   task :choose_target_plugins do

data/lib/tasks/decidim_webpacker_tasks.rake

@@ -89,7 +89,7 @@ namespace :decidim do
         gem_path = Pathname(decidim_gemspec.full_gem_path)
       else
         gem_path = decidim_gemspec.source.path
-        gem_path = Pathname(ENV["BUNDLE_GEMFILE"]).dirname.join(gem_path) if gem_path.relative?
+        gem_path = Pathname(ENV.fetch("BUNDLE_GEMFILE", nil)).dirname.join(gem_path) if gem_path.relative?
       end
 
       gem_path

data/lib/tasks/upgrade/decidim_fix_nickname_uniqueness.rake

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :upgrade do
+    desc "Modify nicknames with random numbers when exists similar ones case insensitively"
+    task fix_nickname_uniqueness: :environment do
+      logger = Logger.new($stdout)
+      logger.info("Updating conflicting user nicknames...")
+
+      # list of users already changed in the process
+      has_changed = []
+
+      Decidim::User.not_deleted.find_each do |user|
+        next if has_changed.include? user.id
+
+        Decidim::User.where(organization: user.organization)
+                     .where("nickname ILIKE ?", user.nickname.downcase)
+                     .where.not(id: has_changed + [user.id])
+                     .not_deleted
+                     .order(:created_at)
+                     .each do |similar_user|
+          # change her nickname to the lowercased one with numbers if needed
+          begin
+            update_user_nickname(similar_user, Decidim::UserBaseEntity.nicknamize(similar_user.nickname, organization: similar_user.organization))
+          rescue ActiveRecord::RecordInvalid => e
+            logger.warn("User ID (#{similar_user.id}) : #{e}")
+          end
+          has_changed.append(similar_user.id)
+        end
+      end
+      logger.info("Process terminated, #{has_changed.count} users nickname have been updated.")
+    end
+
+    private
+
+    def send_notification_to(user)
+      Decidim::EventsManager.publish(
+        event: "decidim.events.nickname_event",
+        event_class: Decidim::ChangeNicknameEvent,
+        affected_users: [user],
+        resource: user
+      )
+    end
+
+    def update_user_nickname(user, new_nickname)
+      user.update!(nickname: new_nickname)
+      send_notification_to(user)
+      user
+    end
+  end
+end