decidim-core 0.30.1 → 0.31.0.rc1

data/lib/decidim/pdf_signature_example.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: false
+
+require "hexapdf"
+require "tempfile"
+
+module Decidim
+  # Example of service to add a signature to a pdf
+  class PdfSignatureExample
+    attr_accessor :pdf
+
+    # Public: Initializes the service.
+    # pdf - The pdf document to be signed
+    def initialize(args = {})
+      @pdf = args.fetch(:pdf)
+    end
+
+    # Public: PDF signed using a new certificate generated by the service
+    def signed_pdf
+      signed_file = Tempfile.new("signed_pdf")
+
+      doc = HexaPDF::Document.new(io: StringIO.new(pdf))
+
+      # Prepare the document for embedding of the digital signature
+      data = nil # Used for storing the to-be-signed data
+      signing_mechanism = lambda do |io, byte_range|
+        # Store the to-be-signed data in the local variable data
+        io.pos = byte_range[0]
+        data = io.read(byte_range[1])
+        io.pos = byte_range[2]
+        data << io.read(byte_range[3])
+        ""
+      end
+      doc.sign(signed_file.path, signature: signature_widget(doc), reason: caption, signature_size: 10_000, external_signing: signing_mechanism)
+
+      signature = OpenSSL::PKCS7.sign(certificate, key, data,
+                                      # [HexaPDF.demo_cert.sub_ca, HexaPDF.demo_cert.root_ca],
+                                      [],
+                                      OpenSSL::PKCS7::DETACHED | OpenSSL::PKCS7::BINARY).to_der
+
+      # Embed the signature
+      HexaPDF::DigitalSignature::Signing.embed_signature(File.open(signed_file.path, "rb+"), signature)
+
+      File.binread(signed_file.path)
+    ensure
+      signed_file.close
+      signed_file.unlink
+    end
+
+    private
+
+    def signature_widget(doc)
+      form = doc.acro_form(create: true)
+      form.signature_flag(:append_only)
+
+      sig_field = form.create_signature_field("signature")
+
+      widget = sig_field.create_widget(doc.pages[doc.pages.length - 1], Rect: [60, 50, 250, 620])
+      widget.flag(:print)
+      xobject = (widget[:AP] ||= {})[:N] ||= doc.add({ Type: :XObject, Subtype: :Form }) # Create the appearance for the widget
+      xobject[:BBox] = [0, 0, widget[:Rect].width, widget[:Rect].height]
+      xobject.canvas
+             .font("Helvetica", size: 10)
+             .text(caption, at: [10, 30])
+
+      sig = doc.add({ Type: :Sig }) # set an empty signature and apply it to the field
+      sig_field.field_value = sig
+      sig
+    end
+
+    def certificate
+      @certificate ||= OpenSSL::X509::Certificate.new.tap do |cert|
+        cert.not_before = Time.current
+        cert.not_after = 10.years.from_now
+
+        cert.public_key = key.public_key
+        cert.sign(key, OpenSSL::Digest.new("SHA256"))
+      end
+    end
+
+    def key
+      @key ||= OpenSSL::PKey::RSA.new(2048)
+    end
+
+    def caption
+      @caption ||= "Digitally Signed By: #{signedby}\nContact: #{contact}\nLocation: #{location}\nDate: #{date.iso8601}"
+    end
+
+    def signedby
+      "Test"
+    end
+
+    def location
+      "Barcelona"
+    end
+
+    def contact
+      "test@example.org"
+    end
+
+    def issuer
+      "Decidim"
+    end
+
+    def date
+      Time.current
+    end
+  end
+end

data/lib/decidim/query.rb

@@ -23,7 +23,7 @@ module Decidim
       queries.reduce(Decidim::Query.new([])) { |a, e| a.merge(e) }
     end
 
-    def initialize(scope = ActiveRecord::NullRelation)
+    def initialize(scope = [])
       @scope = scope
     end
 

data/lib/decidim/query_extensions.rb

@@ -21,16 +21,6 @@ module Decidim
 
       type.field :organization, Core::OrganizationType, "The current organization", null: true
 
-      type.field :hashtags, [Core::HashtagType], null: true, description: "The hashtags for current organization" do
-        argument :name, GraphQL::Types::String, "The name of the hashtag", required: false
-      end
-
-      type.field :metrics, type: [Decidim::Core::MetricType], null: true do
-        argument :names, [GraphQL::Types::String], "The names of the metrics you want to retrieve", camelize: false, required: false
-        argument :space_type, GraphQL::Types::String, "The type of ParticipatorySpace you want to filter with", camelize: false, required: false
-        argument :space_id, GraphQL::Types::Int, "The ID of ParticipatorySpace you want to filter with", camelize: false, required: false
-      end
-
       type.field :user,
                  type: Core::AuthorInterface, null: true,
                  description: "A participant (user or group) in the current organization" do
@@ -63,29 +53,6 @@ module Decidim
       context[:current_organization]
     end
 
-    def hashtags(name: nil)
-      Decidim::HashtagsResolver.new(context[:current_organization], name).hashtags
-    end
-
-    def metrics(names: [], space_type: nil, space_id: nil)
-      manifests = if names.blank?
-                    Decidim.metrics_registry.all
-                  else
-                    Decidim.metrics_registry.all.select do |manifest|
-                      names.include?(manifest.metric_name.to_s)
-                    end
-                  end
-      filters = {}
-      if space_type.present? && space_id.present?
-        filters[:participatory_space_type] = space_type
-        filters[:participatory_space_id] = space_id
-      end
-
-      manifests.map do |manifest|
-        Decidim::Core::MetricResolver.new(manifest.metric_name, context[:current_organization], filters)
-      end
-    end
-
     def user(id: nil, nickname: nil)
       Core::UserEntityFinder.new.call(object, { id:, nickname: }, context)
     end

data/lib/decidim/reportable.rb

@@ -21,7 +21,7 @@ module Decidim
       def can_be_administered_by?(user)
         return false if user.blank?
         return true if user.admin?
-        return false if participatory_space.respond_to?(:user_roles) && participatory_space.user_roles(:valuator).where(user:).any?
+        return false if participatory_space.respond_to?(:user_roles) && participatory_space.user_roles(:evaluator).where(user:).any?
 
         [
           participatory_space.moderators.exists?(id: user.id),

data/lib/decidim/searchable.rb

@@ -27,11 +27,13 @@ module Decidim
     end
 
     def self.searchable_resources_of_type_participant
-      searchable_resources.slice("Decidim::User", "Decidim::UserGroup")
+      searchable_resources.slice("Decidim::User")
     end
 
     def self.searchable_resources_of_type_participatory_space
-      searchable_resources.select { |r| r.constantize.reflect_on_association(:components).present? }
+      searchable_resources
+        .select { |r| r.constantize.reflect_on_association(:organization).present? }
+        .reject { |r| searchable_resources_of_type_participant.keys.include?(r) }
     end
 
     def self.searchable_resources_of_type_component

data/lib/decidim/seeds.rb

@@ -9,6 +9,14 @@ module Decidim
   class Seeds
     protected
 
+    def slow_seeds?
+      Decidim::Env.new("SLOW_SEEDS").present?
+    end
+
+    def number_of_records
+      slow_seeds? ? rand(3..5) : 1
+    end
+
     def organization
       @organization ||= Decidim::Organization.first
     end

data/lib/decidim/settings_manifest.rb

@@ -129,6 +129,7 @@ module Decidim
       attribute :required_for_authorization, Boolean, default: false
       attribute :readonly
       attribute :choices
+      attribute :raw_choices, Boolean, default: false
       attribute :units
       attribute :include_blank, Boolean, default: false
 
@@ -154,8 +155,8 @@ module Decidim
         default || TYPES[type][:default]
       end
 
-      def build_choices
-        choices.try(:call) || choices
+      def build_choices(context = nil)
+        choices.try(:call, context) || choices
       end
 
       def build_units

data/lib/decidim/{webpacker → shakapacker}/configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Decidim
-  module Webpacker
+  module Shakapacker
     class Configuration
       attr_reader :additional_paths, :entrypoints, :stylesheet_imports
 
@@ -12,7 +12,7 @@ module Decidim
       end
 
       def configuration_file
-        # Before webpacker is installed, the original configuration file may not
+        # Before shakapacker is installed, the original configuration file may not
         # be available yet.
         return unless File.exist?(original_configuration_file_path)
         return configuration_file_path if configurations_loaded?
@@ -58,13 +58,13 @@ module Decidim
           if defined?(Rails)
             Rails.application.root
           else
-            # This is used when Rails is not available from the webpacker binstubs
+            # This is used when Rails is not available from the shakapacker binstubs
             File.expand_path(".", Dir.pwd)
           end
       end
 
       def configuration_file_path
-        @configuration_file_path ||= File.join(app_path, "tmp/webpacker_runtime.yml")
+        @configuration_file_path ||= File.join(app_path, "tmp/shakapacker_runtime.yml")
       end
 
       def original_configuration_file_path

data/lib/decidim/{webpacker → shakapacker}/runner.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 module Decidim
-  module Webpacker
+  module Shakapacker
     module Runner
       def self.included(base)
         base.alias_method :original_initialize, :initialize
         base.send :private, :original_initialize
 
         base.define_method :initialize do |argv|
-          original_initialize(argv)
           decidim_initialize(argv)
+          original_initialize(argv)
         end
       end
 
@@ -22,7 +22,7 @@ module Decidim
         Decidim::Assets::Tailwind.write_runtime_configuration
 
         # Write the runtime configuration and override the configuration
-        @shakapacker_config = Decidim::Webpacker.configuration.configuration_file
+        ENV["SHAKAPACKER_CONFIG"] = Decidim::Shakapacker.configuration.configuration_file
       end
     end
   end

data/lib/decidim/shakapacker/shakapacker.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "shakapacker"
+require "shakapacker/runner"
+require "decidim/shakapacker"
+require "decidim/webpacker"
+
+Shakapacker::Runner.include(Decidim::Shakapacker::Runner)

data/lib/decidim/{webpacker → shakapacker}/shakapacker.yml

@@ -1,5 +1,5 @@
 # File written by Decidim generator
-# Note: You must restart bin/webpack-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   source_path: app/packs
@@ -62,6 +62,8 @@ development:
       #  port: 8080
     # Should we use gzip compression?
     compress: true
+    # Disable live reloading for faster development experience
+    live_reload: false
     # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
     allowed_hosts: "all"
     pretty: true

data/lib/decidim/{webpacker → shakapacker}/webpack/custom.js

@@ -44,7 +44,7 @@ module.exports = {
           filename: "media/documents/[hash][ext][query]"
         }
       },
-      // Overwrite webpacker files rule to amend the filename output
+      // Overwrite shakapacker files rule to amend the filename output
       // and include the name of the file, otherwise some SVGs
       // are not generated because the hash is the same between them
       {

data/lib/decidim/shakapacker.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "decidim/assets"
+
+module Decidim
+  module Shakapacker
+    autoload :Configuration, "decidim/shakapacker/configuration"
+    autoload :Runner, "decidim/shakapacker/runner"
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.register_path(path, prepend: false)
+      if prepend
+        configuration.additional_paths.unshift(path)
+      else
+        configuration.additional_paths.push(path)
+      end
+    end
+
+    def self.register_entrypoints(entrypoints)
+      configuration.entrypoints.merge!(entrypoints.stringify_keys)
+    end
+
+    def self.register_stylesheet_import(import, type: :imports, group: :app)
+      type = type.to_s
+      key = group.to_s
+      configuration.stylesheet_imports[type] ||= {}
+      configuration.stylesheet_imports[type][key] ||= []
+      configuration.stylesheet_imports[type][key].push(import)
+    end
+  end
+end

data/lib/decidim/social_share_service_manifest.rb

@@ -10,12 +10,12 @@ module Decidim
     attribute :name, String
     attribute :icon, String
     attribute :share_uri, String
-    attribute :icon_color, String
+    attribute :type, Symbol, default: :link
     attribute :optional_params, Array
+    attribute :optional_args, Hash, default: {}
 
     validates :name, presence: true
     validates :icon, presence: true
-    validates :icon_color, presence: false
     validates :share_uri, presence: true, format: { with: /%{url}/ }
 
     # Format a given URL to be shareable
@@ -27,8 +27,10 @@ module Decidim
     # @return [String, nil] The formatted URL or nil when some or one of the
     #   required parameters is missing
     def formatted_share_uri(title, args)
+      return "#" unless link?
+
       formatted_args = escape_args(args.compact)
-      format(full_share_uri(formatted_args.keys), title: url_escape(title), **formatted_args)
+      format(share_uri, title: url_escape(title), **formatted_args)
     rescue KeyError
       # This happens when all the arguments needed for the `format()` call are
       # not provided in the `formatted_args` array. E.g. the URL of the page
@@ -47,15 +49,8 @@ module Decidim
 
     private
 
-    # Add optional parameters to a share_uri
-    # This is initially developed for Twitter, as they allow sending a Hashtag and Via as parameters
-    #
-    # @param keys [Array<Symbol>] all the parameters that this service support
-    # @return [String] the share uri with the parameters and optional parameters
-    def full_share_uri(keys)
-      return share_uri if optional_params.empty?
-
-      share_uri + (optional_params.map(&:to_sym) & keys).map { |k| "&#{k}=%{#{k}}" }.join
+    def link?
+      type == :link
     end
 
     # Escape the values of a hash so it has characters compatible with URLs

data/lib/decidim/stats_registry.rb

@@ -3,8 +3,8 @@
 module Decidim
   # This class stores different stats computations and resolves them given a context.
   class StatsRegistry
-    HIGH_PRIORITY = 1
-    MEDIUM_PRIORITY = 2
+    HIGH_PRIORITY = 1 # The priority of the stat used for render organization level stats.
+    MEDIUM_PRIORITY = 2 # The priority of the stat used for render participatory space level stats.
     LOW_PRIORITY = 3
 
     attr_reader :stats
@@ -28,12 +28,17 @@ module Decidim
       raise StandardError, "Stats '#{name}' is already registered." if stat.present?
 
       options[:primary] ||= false
+      options[:admin] = true unless options.has_key?(:admin)
       options[:priority] ||= LOW_PRIORITY
 
       @stats.push(name:,
                   primary: options[:primary],
                   priority: options[:priority],
                   tag: options[:tag],
+                  icon_name: options[:icon_name],
+                  tooltip_key: options[:tooltip_key],
+                  sub_title: options[:sub_title],
+                  admin: options[:admin],
                   block:)
     end
 
@@ -62,7 +67,14 @@ module Decidim
     def with_context(context, start_at = nil, end_at = nil)
       Enumerator.new do |yielder|
         @stats.each do |stat|
-          yielder << [stat[:name], resolve(stat[:name], context, start_at, end_at)]
+          yielder << {
+            name: stat[:name],
+            data: resolve(stat[:name], context, start_at, end_at),
+            icon_name: stat[:icon_name],
+            tooltip_key: stat[:tooltip_key],
+            sub_title: stat[:sub_title],
+            admin: stat[:admin]
+          }
         end
       end
     end

data/{app/helpers → lib}/decidim/tooltip_helper.rb

@@ -5,10 +5,10 @@ module Decidim
   # on the layout.
   module TooltipHelper
     def with_tooltip(title, opts = {}, &)
-      content_tag(:p,
-                  title:,
+      content_tag(:span,
                   class: "inline-block",
-                  data: { tooltip: content_tag(:p, title, id: opts[:id], class: opts[:class] || "bottom", role: "tooltip", "aria-hidden": "true") }) do
+                  data: { controller: :tooltip,
+                          "tooltip-tooltip-value": content_tag(:p, title, id: opts[:id], class: opts[:class] || "bottom", role: "tooltip", "aria-hidden": "true") }) do
         capture(&).html_safe
       end
     end

data/lib/decidim/url_option_resolver.rb

@@ -20,7 +20,7 @@ module Decidim
     def host
       @host ||= begin
         default_host = nil
-        default_host = "localhost" if Rails.env.development? || Rails.env.test?
+        default_host = "localhost" if Rails.env.local?
 
         ENV.fetch("HOSTNAME", default_host)
       end

data/lib/decidim/view_model.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 module Decidim
-  autoload :ActionAuthorizationHelper, "decidim/action_authorization_helper"
-  autoload :ResourceHelper, "decidim/resource_helper"
-
   class ViewModel < Cell::ViewModel
     include ActionView::Helpers::TranslationHelper
     include ::Cell::Translation

data/lib/decidim/webpacker.rb

@@ -1,34 +1,25 @@
 # frozen_string_literal: true
 
-require "decidim/assets"
-
 module Decidim
   module Webpacker
-    autoload :Configuration, "decidim/webpacker/configuration"
-    autoload :Runner, "decidim/webpacker/runner"
-
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
-
     def self.register_path(path, prepend: false)
-      if prepend
-        configuration.additional_paths.unshift(path)
-      else
-        configuration.additional_paths.push(path)
-      end
+      deprecator.warn "Decidim::Webpacker.register_path is deprecated. Please use Decidim::Shakapacker.register_path instead."
+      Decidim::Shakapacker.register_path(path, prepend:)
     end
 
     def self.register_entrypoints(entrypoints)
-      configuration.entrypoints.merge!(entrypoints.stringify_keys)
+      deprecator.warn "Decidim::Webpacker.register_entrypoints is deprecated. Please use Decidim::Shakapacker.register_entrypoints instead."
+      Decidim::Shakapacker.register_entrypoints(entrypoints)
     end
 
     def self.register_stylesheet_import(import, type: :imports, group: :app)
-      type = type.to_s
-      key = group.to_s
-      configuration.stylesheet_imports[type] ||= {}
-      configuration.stylesheet_imports[type][key] ||= []
-      configuration.stylesheet_imports[type][key].push(import)
+      deprecator.warn "Decidim::Webpacker.register_stylesheet_import is deprecated. Please use Decidim::Shakapacker.register_stylesheet_import instead."
+      Decidim::Shakapacker.register_stylesheet_import(import, type:, group:)
+    end
+
+    def self.deprecator(gem_name: "decidim-core", deprecation_horizon: "0.32")
+      require "active_support/deprecation"
+      @deprecator ||= ActiveSupport::Deprecation.new(deprecation_horizon, gem_name)
     end
   end
 end

data/lib/decidim/workflow_registry.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  # Class to manage a collection of workflows
+  class WorkflowRegistry
+    attr_reader :workflow_collection
+
+    def initialize(workflow_manifest_class)
+      @workflow_manifest_class = workflow_manifest_class
+      @workflow_collection = Set.new
+    end
+
+    #
+    # Registers a new workflow using the workflow manifest API
+    #
+    def register_workflow(name)
+      manifest = @workflow_manifest_class.new(name: name.to_s)
+      yield(manifest)
+      add_workflow(manifest)
+    end
+
+    #
+    # Unregisters a workflow using the workflow manifest API
+    #
+    def unregister_workflow(manifest)
+      manifest = find_workflow_manifest(manifest) if manifest.is_a?(String)
+      workflow_collection.delete(manifest)
+    end
+
+    #
+    # Restores registered workflows to the array being passed in
+    #
+    # Useful for testing.
+    #
+    def reset_workflows(*manifests)
+      clear_workflows
+
+      manifests.each do |manifest|
+        add_workflow(manifest)
+      end
+    end
+
+    #
+    # Finds a workflow by name
+    #
+    def find_workflow_manifest(name)
+      workflow_collection.find { |workflow| workflow.name == name.to_s }
+    end
+
+    private
+
+    def add_workflow(manifest)
+      manifest.validate!
+      workflow_collection.add(manifest)
+    end
+
+    def clear_workflows
+      workflow_collection.clear
+    end
+  end
+end

data/lib/tasks/decidim_participants_tasks.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :participants do
+    desc "Delete inactive participants after a configurable inactivity period"
+    task :delete_inactive_participants, [:days] => :environment do |_task, args|
+      inactivity_period_days = args[:days]&.to_i || Decidim.delete_inactive_users_after_days
+      minimum_inactivity_period = Decidim.minimum_inactivity_period
+
+      if inactivity_period_days < minimum_inactivity_period
+        raise <<~ERROR_MESSAGE
+          The number of days of inactivity period is too low.
+          Minimum allowed is #{minimum_inactivity_period} days.
+        ERROR_MESSAGE
+      end
+
+      Decidim::Organization.find_each do |organization|
+        Decidim::DeleteInactiveParticipantsJob.perform_later(organization)
+      end
+    end
+  end
+end