decidim-core 0.19.1 → 0.23.0

data/lib/decidim/participable.rb

@@ -85,6 +85,12 @@ module Decidim
 
         :take_part
       end
+
+      def cta_button_text_key_accessible
+        return :more_info_about if empty_published_component?
+
+        :take_part_in
+      end
     end
 
     class_methods do

data/lib/decidim/participatory_space_manifest.rb

@@ -2,6 +2,7 @@
 
 require "decidim/settings_manifest"
 require "decidim/participatory_space_context_manifest"
+require "decidim/exporters/export_manifest"
 
 module Decidim
   # This class handles all the logic associated to configuring a participatory
@@ -23,6 +24,8 @@ module Decidim
     attribute :route_name, String
 
     attribute :query_type, String, default: "Decidim::Core::ParticipatorySpaceType"
+    attribute :query_finder, String, default: "Decidim::Core::ParticipatorySpaceFinder"
+    attribute :query_list, String, default: "Decidim::Core::ParticipatorySpaceList"
 
     # An array with the name of the classes that will be exported with
     # the data portability feature for this component. For example, `Decidim::<MyModule>::<MyClass>``
@@ -44,6 +47,10 @@ module Decidim
     # use the scss variables and mixins provided by Decidim::Core.
     attribute :stylesheet, String, default: nil
 
+    # A callback that will be executed when an account is destroyed.
+    # The Proc will receive the `user` that's being destroyed.
+    attribute :on_destroy_account, Proc, default: nil
+
     validates :name, presence: true
 
     # A context used to set the layout and behavior of a participatory space. Full documentation can
@@ -112,6 +119,24 @@ module Decidim
       permissions_class_name&.constantize
     end
 
+    # Public: Stores an instance of StatsRegistry
+    def stats
+      @stats ||= StatsRegistry.new
+    end
+
+    # Public: Registers a stat inside a participatory_space manifest.
+    #
+    # name - The name of the stat
+    # options - A hash of options
+    #         * primary: Whether the stat is primary or not.
+    #         * priority: The priority of the stat used for render issues.
+    # block - A block that receive the components to filter out the stat.
+    #
+    # Returns nothing.
+    def register_stat(name, options = {}, &block)
+      stats.register(name, options, &block)
+    end
+
     # Public: Registers a resource. Exposes a DSL defined by
     # `Decidim::ResourceManifest`.
     #
@@ -125,5 +150,48 @@ module Decidim
     def register_resource(name, &block)
       Decidim.register_resource(name, &block)
     end
+
+    # Public: Registers an export artifact with a name and its properties
+    # defined in `Decidim::Exporters::ExportManifest`.
+    #
+    # Export artifacts provide a unified way for processes to register
+    # exportable collections serialized via a `Serializer` that eventually
+    # are transformed to their formats.
+    #
+    # name  - The name of the artifact for this export. Should be unique in the
+    # context of the space.
+    # block - A block that receives the manifest as its only argument.
+    #
+    # Returns nothing.
+    def exports(name, &block)
+      return unless name
+
+      @exports ||= []
+      @exports << [name, block]
+      @export_manifests = nil
+    end
+
+    # Pubic: Returns a collection of previously registered export manifests
+    # for this space.
+    #
+    # Returns an Array of <Decidim::Exporters::ExportManifest>.
+    def export_manifests
+      @export_manifests ||= Array(@exports).map do |(name, block)|
+        Decidim::Exporters::ExportManifest.new(name, self).tap do |manifest|
+          block.call(manifest)
+        end
+      end
+    end
+
+    # The block is a callback that will be invoked with the destroyed `user` as argument.
+    def register_on_destroy_account(&block)
+      @on_destroy_account = block
+    end
+
+    def invoke_on_destroy_account(user)
+      return unless @on_destroy_account
+
+      @on_destroy_account.call(user)
+    end
   end
 end

data/lib/decidim/participatory_space_resourceable.rb

@@ -20,6 +20,8 @@ module Decidim
     extend ActiveSupport::Concern
 
     included do
+      extend Decidim::Deprecations
+
       # An association with all the links that point to this model.
       has_many :participatory_space_resource_links_to, as: :to, class_name: "Decidim::ParticipatorySpaceLink"
 
@@ -64,7 +66,7 @@ module Decidim
       # data      - An optional Hash to add to the link.
       #
       # Returns nothing.
-      def link_participatory_spaces_resources(resources, link_name, data = {})
+      def link_participatory_space_resources(resources, link_name, data = {})
         transaction do
           participatory_space_resource_links_from.where(name: link_name).delete_all
           Array.wrap(resources).each do |resource|
@@ -77,6 +79,7 @@ module Decidim
           end
         end
       end
+      deprecated_alias :link_participatory_spaces_resources, :link_participatory_space_resources
 
       # Public: This method will be used to represent this participatory space in other contexts, like cards
       # or search results.
@@ -89,6 +92,45 @@ module Decidim
       def resource_description
         try(:description) || try(:body) || try(:content)
       end
+
+      # Checks if this ParticipatorySpace should be visible in the public views.
+      # i.e. checks
+      # - is published
+      # - is not private
+      def visible?
+        published? && !try(:private_space?)
+      end
+
+      # Defines a way to get the user roles for the current participatory space.
+      # You should overwrite this method in the implementer class to define how
+      # to get the correct values.
+      #
+      # role_name - A symbol or string identifying the role name
+      #
+      # Returns an ActiveRecord::Relation with one role for each combination of
+      # `ParticipatorySpace` and `*UserRole`. `*` meaning that the concrete
+      # implementation of the `UserRole` may change depending on the
+      # `ParticipatorySpace` where it belongs to.
+      def user_roles(_role_name = nil)
+        self.class.none
+      end
+
+      def user_role_config_for(user, role_name)
+        case role_name.to_sym
+        when :organization_admin
+          Decidim::ParticipatorySpaceRoleConfig::Admin.new(user)
+        when :admin # ParticipatorySpace admin
+          Decidim::ParticipatorySpaceRoleConfig::ParticipatorySpaceAdmin.new(user)
+        when :valuator
+          Decidim::ParticipatorySpaceRoleConfig::Valuator.new(user)
+        when :moderator
+          Decidim::ParticipatorySpaceRoleConfig::Moderator.new(user)
+        when :collaborator
+          Decidim::ParticipatorySpaceRoleConfig::Collaborator.new(user)
+        else
+          Decidim::ParticipatorySpaceRoleConfig::NullObject.new(user)
+        end
+      end
     end
 
     class_methods do

data/lib/decidim/query_extensions.rb

@@ -14,29 +14,15 @@ module Decidim
     # Returns nothing.
     def self.define(type)
       Decidim.participatory_space_manifests.each do |participatory_space_manifest|
-        type.field participatory_space_manifest.name.to_s.camelize(:lower) do
-          type types[participatory_space_manifest.query_type.constantize]
-          description "Lists all #{participatory_space_manifest.name}"
-
-          resolve lambda { |_obj, _args, ctx|
-            participatory_space_manifest.model_class_name.constantize.public_spaces.where(
-              organization: ctx[:current_organization]
-            )
-          }
-        end
-
-        type.field participatory_space_manifest.name.to_s.singularize.camelize(:lower) do
-          type participatory_space_manifest.query_type.constantize
-          description "Finds a #{participatory_space_manifest.name.to_s.singularize}"
-          argument :id, !types.ID, "The ID of the #{participatory_space_manifest.name.to_s.singularize}"
-
-          resolve lambda { |_obj, args, ctx|
-            participatory_space_manifest.model_class_name.constantize.public_spaces.find_by(
-              organization: ctx[:current_organization],
-              id: args[:id]
-            )
-          }
-        end
+        type.field participatory_space_manifest.name.to_s.camelize(:lower),
+                   type: type.types[participatory_space_manifest.query_type.constantize],
+                   description: "Lists all #{participatory_space_manifest.name}",
+                   function: participatory_space_manifest.query_list.constantize.new(manifest: participatory_space_manifest)
+
+        type.field participatory_space_manifest.name.to_s.singularize.camelize(:lower),
+                   type: participatory_space_manifest.query_type.constantize,
+                   description: "Finds a #{participatory_space_manifest.name.to_s.singularize}",
+                   function: participatory_space_manifest.query_finder.constantize.new(manifest: participatory_space_manifest)
       end
 
       type.field :component, Decidim::Core::ComponentInterface do
@@ -101,6 +87,16 @@ module Decidim
                   end
                 }
       end
+
+      type.field :user,
+                 type: Core::AuthorInterface,
+                 description: "A participant (user or group) in the current organization",
+                 function: Core::UserEntityFinder.new
+
+      type.field :users,
+                 type: type.types[Core::AuthorInterface],
+                 description: "The participants (users or groups) for the current organization",
+                 function: Core::UserEntityList.new
     end
   end
 end

data/lib/decidim/resource_manifest.rb

@@ -66,7 +66,7 @@ module Decidim
       component_ids = Decidim::Component.where(participatory_space: component.participatory_space, manifest_name: component_manifest.name).pluck(:id)
       return model_class.none if component_ids.empty?
 
-      model_class.where(component: component_ids)
+      model_class.joins(:component).where(decidim_components: { id: component_ids })
     end
 
     # Finds the current class with the given `model_class_name`

data/lib/decidim/resourceable.rb

@@ -87,7 +87,7 @@ module Decidim
 
       delegate :resource_manifest, to: :class
 
-      # Checks throughout all its parent hierarchy if this Resource is visible.
+      # Checks throughout all its parent hierarchy if this Resource should be visible in the public views.
       # i.e. checks
       # - the visibility of its parent Component
       # - the visibility of its participatory space.

data/lib/decidim/scopable.rb

@@ -23,16 +23,18 @@ module Decidim
     extend ActiveSupport::Concern
 
     included do
-      belongs_to :scope,
-                 foreign_key: "decidim_scope_id",
-                 class_name: "Decidim::Scope",
-                 optional: true
-
       delegate :scopes, to: :organization
 
       validate :scope_belongs_to_organization
     end
 
+    # Whether the resource has scopes enabled or not.
+    #
+    # Returns a boolean.
+    def scopes_enabled?
+      scopes_enabled
+    end
+
     # Gets the children scopes of the object's scope.
     #
     # If it's global, returns the organization's top scopes.
@@ -46,7 +48,7 @@ module Decidim
     #
     # Returns a boolean.
     def has_subscopes?
-      scopes_enabled && subscopes.any?
+      scopes_enabled? && subscopes.any?
     end
 
     # Whether the passed subscope is out of the resource's scope.
@@ -56,8 +58,19 @@ module Decidim
       scope && !scope.ancestor_of?(subscope)
     end
 
+    # If any, gets the previous scope of the object.
+    #
+    #
+    # Returns a Decidim::Scope
+    def previous_scope
+      return if versions.count <= 1
+
+      Decidim::Scope.find_by(id: versions.last.reify.decidim_scope_id)
+    end
+
     private
 
+    # Validation to ensure that the resource is scoped within the organization's scope.
     def scope_belongs_to_organization
       return if !scope || !organization
 

data/lib/decidim/scopable_component.rb

@@ -10,7 +10,35 @@ module Decidim
     included do
       include Scopable
 
-      delegate :scopes_enabled, to: :participatory_space
+      validate :scope_belongs_to_participatory_space
+
+      # Whether the component or participatory_space has subscopes or not.
+      #
+      # Returns a boolean.
+      def has_subscopes?
+        (scopes_enabled? || participatory_space.scopes_enabled?) && subscopes.any?
+      end
+
+      # Public: Returns the component Scope
+      def scope
+        return participatory_space.scope unless scopes_enabled?
+
+        participatory_space.scopes.find_by(id: settings.scope_id)
+      end
+
+      # Returns a boolean.
+      def scopes_enabled
+        settings.try(:scopes_enabled)
+      end
+
+      private
+
+      # Validation to ensure that the component is scoped within its participatory space Scope.
+      def scope_belongs_to_participatory_space
+        return if !scopes_enabled? || !participatory_space
+
+        errors.add(:scope, :invalid) if participatory_space.out_of_scope?(scope)
+      end
     end
   end
 end

data/lib/decidim/scopable_participatory_space.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  # Specific methods for scoped participatory spaces.
+  module ScopableParticipatorySpace
+    extend ActiveSupport::Concern
+
+    included do
+      include Scopable
+
+      belongs_to :scope,
+                 foreign_key: "decidim_scope_id",
+                 class_name: "Decidim::Scope",
+                 optional: true
+    end
+  end
+end

data/lib/decidim/scopable_resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  # This concern contains the logic related to scopes included by resources.
+  module ScopableResource
+    extend ActiveSupport::Concern
+
+    included do
+      include Scopable
+
+      belongs_to :scope,
+                 foreign_key: "decidim_scope_id",
+                 class_name: "Decidim::Scope",
+                 optional: true
+
+      delegate :scopes_enabled, to: :component
+    end
+  end
+end

data/lib/decidim/search_resource_fields_mapper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Decidim
-  # A class with the responsibility to mapp fields between a Searchable and a SearchableResource.
+  # A class with the responsibility to map fields between a Searchable and a SearchableResource.
   class SearchResourceFieldsMapper
+    include ActionView::Helpers::SanitizeHelper
+
     #
     # Declared fields may be of types:
     # - Hash for deep associations.
@@ -125,8 +127,19 @@ module Decidim
       return if content.nil?
 
       content = Array.wrap(content).collect do |item|
-        item.is_a?(Hash) ? item[locale] : item
+        text = if item.is_a?(Hash)
+                 item.dig(locale).presence || item.dig("machine_translations", locale) || ""
+               else
+                 item
+               end
+
+        if text.is_a?(String)
+          strip_tags(Decidim::ContentProcessor.render_without_format(text, links: false))
+        else
+          text
+        end
       end
+
       content.respond_to?(:join) ? content.join(" ") : content
     end
   end

data/lib/decidim/searchable.rb

@@ -26,6 +26,22 @@ module Decidim
       end
     end
 
+    def self.searchable_resources_of_type_participant
+      searchable_resources.select { |r| r == "Decidim::User" }
+    end
+
+    def self.searchable_resources_of_type_participatory_space
+      searchable_resources.select { |r| r.constantize.reflect_on_association(:components).present? }
+    end
+
+    def self.searchable_resources_of_type_component
+      searchable_resources.select { |r| r.constantize.ancestors.include?(Decidim::HasComponent) }
+    end
+
+    def self.searchable_resources_of_type_comment
+      searchable_resources.select { |r| r == "Decidim::Comments::Comment" }
+    end
+
     included do
       # Always access to this association scoping by_organization
       clazz = self
@@ -49,7 +65,7 @@ module Decidim
       # Public: after_create callback to index the model as a SearchableResource, if configured so.
       #
       def try_add_to_index_as_search_resource
-        return unless self.class.search_resource_fields_mapper.index_on_create?(self)
+        return unless self.class.searchable_resource?(self) && self.class.search_resource_fields_mapper.index_on_create?(self)
 
         add_to_index_as_search_resource
       end
@@ -65,6 +81,8 @@ module Decidim
       # Public: after_update callback to update index information of the model.
       #
       def try_update_index_for_search_resource
+        return unless self.class.searchable_resource?(self)
+
         org = self.class.search_resource_fields_mapper.retrieve_organization(self)
         searchables_in_org = searchable_resources.by_organization(org.id)
         if self.class.search_resource_fields_mapper.index_on_update?(self)
@@ -145,6 +163,10 @@ module Decidim
           @search_resource_indexable_fields.set_index_condition(:update, conditions[:index_on_update])
         end
       end
+
+      def searchable_resource?(resource)
+        Decidim::Searchable.searchable_resources.include?(resource.class.name)
+      end
     end
   end
 end