decidim-core 0.8.4 → 0.9.0

data/lib/decidim/content_processor.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This module contains all logic related to decidim's ability for process a content.
+  # Their main job is to {ContentProcessor#parse parse} or {ContentProcessor#render render}
+  # a content calling all the registered processors in the Decidim.content_processors config.
+  #
+  # Note that to render a content this must have been parsed before.
+  #
+  # When creating a new processor, the both sides must be declared: parser and renderer
+  # e.g. If we are creating a processor to parse and render user mentions, we can call this
+  # the `user` processor, so we will declare the parser and renderer classes like that:
+  #
+  #   Decidim::ContentParsers::UserParser
+  #   Decidim::ContentRenderers::UserRenderer
+  #
+  # and register it in an initializer, so it is executed:
+  #
+  #   Decidim.content_processors += [:user]
+  #
+  # If for some reason you only want to do something in one of the both sides, please, also
+  # declare the other side making it "transparent" (declaring the class and leaving it empty).
+  #
+  # @example How to parse a content
+  #   parsed = Decidim::ContentProcessor.parse(content)
+  #   parsed.rewrite # contains rewritten content
+  #   parsed.metadata # contains the merged metadata of all parsers
+  #
+  # @example How to render a content (must have been parsed before)
+  #   rendered = Decidim::ContentProcessor.render(content)
+  #   puts rendered
+  module ContentProcessor
+    # Class that represents the result of processing a text
+    #
+    # @!attribute rewrite
+    #   @return [String] the rewritten content
+    # @!attribute metadata
+    #   @return [Hash<Symbol, Metadata>] a hash where the keys are the parsers
+    #     names, and the values are the Metadata object returned by the parser
+    Result = Struct.new(:rewrite, :metadata)
+
+    # This calls all registered processors one after the other and collects the
+    # metadata for each one and the resulting modified content
+    #
+    # @return [Result] a Result object with the content rewritten and the metadata
+    def self.parse(content)
+      parsed = Decidim.content_processors.each_with_object(rewrite: content, metadata: {}) do |type, result|
+        parser = parser_klass(type).constantize.new(result[:rewrite])
+        result[:rewrite] = parser.rewrite
+        result[:metadata][type] = parser.metadata
+      end
+
+      Result.new(parsed[:rewrite], parsed[:metadata])
+    end
+
+    # This calls all registered processors one after the other and returns
+    # the processed content ready to display.
+    #
+    # @return [String] the content processed and ready to display (it is expected to include HTML)
+    def self.render(content)
+      Decidim.content_processors.reduce(content) do |result, type|
+        renderer_klass(type).constantize.new(result).render
+      end
+    end
+
+    # Guess the class name of the parser for a processor
+    # represented by the given symbol
+    #
+    # @api private
+    # @return [String] the content parser class name
+    def self.parser_klass(type)
+      "Decidim::ContentParsers::#{type.to_s.camelize}Parser"
+    end
+
+    # Guess the class name of the renderer for a processor
+    # represented by the given symbol
+    #
+    # @api private
+    # @return [String] the content renderer class name
+    def self.renderer_klass(type)
+      "Decidim::ContentRenderers::#{type.to_s.camelize}Renderer"
+    end
+  end
+end

data/lib/decidim/content_renderers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    autoload :BaseRenderer, "decidim/content_renderers/base_renderer"
+    autoload :UserRenderer, "decidim/content_renderers/user_renderer"
+  end
+end

data/lib/decidim/content_renderers/base_renderer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    # Abstract base class for content renderers, so they have the same contract
+    #
+    # @example How to use a content renderer class
+    #   renderer = Decidim::ContentRenderers::CustomRenderer.new(content)
+    #   parser.render # returns the content formatted
+    #
+    # @abstract Subclass and override {#render} to implement a content renderer
+    class BaseRenderer
+      # @return [String] the content to be formatted
+      attr_reader :content
+
+      # Gets initialized with the `content` to format
+      #
+      # @param content [String] content to be formatted
+      def initialize(content)
+        @content = content || ""
+      end
+
+      # Format the content and return it ready to display
+      #
+      # @example Implementation to display prohibited words
+      #   def render
+      #     content.gsub(/\~\~(.*?)\~\~/, '<del>\1</del>')
+      #   end
+      #
+      # @abstract Subclass is expected to implement it
+      # @return [String] the content processed and ready to display
+      def render
+        content
+      end
+    end
+  end
+end

data/lib/decidim/content_renderers/user_renderer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    # A renderer that searches Global IDs representing users in content
+    # and replaces it with a link to their profile with the nickname.
+    #
+    # e.g. gid://<APP_NAME>/Decidim::User/1
+    #
+    # @see BaseRenderer Examples of how to use a content renderer
+    class UserRenderer < BaseRenderer
+      # Matches a global id representing a Decidim::User
+      GLOBAL_ID_REGEX = %r{gid://.*/Decidim::User/\d+}
+
+      # Replaces found Global IDs matching an existing user with
+      # a link to their profile. The Global IDs representing an
+      # invalid Decidim::User are replaced with an empty string.
+      #
+      # @return [String] the content ready to display (contains HTML)
+      def render
+        content.gsub(GLOBAL_ID_REGEX) do |user_gid|
+          begin
+            user = GlobalID::Locator.locate(user_gid)
+            Decidim::UserPresenter.new(user).display_mention
+          rescue ActiveRecord::RecordNotFound => _ex
+            ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/core.rb

@@ -21,6 +21,9 @@ module Decidim
   autoload :Participable, "decidim/participable"
   autoload :Publicable, "decidim/publicable"
   autoload :Scopable, "decidim/scopable"
+  autoload :ContentParsers, "decidim/content_parsers"
+  autoload :ContentRenderers, "decidim/content_renderers"
+  autoload :ContentProcessor, "decidim/content_processor"
   autoload :Features, "decidim/features"
   autoload :HasAttachments, "decidim/has_attachments"
   autoload :FeatureValidator, "decidim/feature_validator"
@@ -29,6 +32,8 @@ module Decidim
   autoload :HasScope, "decidim/has_scope"
   autoload :HasCategory, "decidim/has_category"
   autoload :Followable, "decidim/followable"
+  autoload :FriendlyDates, "decidim/friendly_dates"
+  autoload :Nicknamizable, "decidim/nicknamizable"
   autoload :HasReference, "decidim/has_reference"
   autoload :Attributes, "decidim/attributes"
   autoload :StatsRegistry, "decidim/stats_registry"
@@ -43,6 +48,7 @@ module Decidim
   autoload :EngineRouter, "decidim/engine_router"
   autoload :Events, "decidim/events"
   autoload :ViewHooks, "decidim/view_hooks"
+  autoload :NewsletterEncryptor, "decidim/newsletter_encryptor"
 
   include ActiveSupport::Configurable
 
@@ -87,7 +93,24 @@ module Decidim
 
   # Exposes a configuration option: The application available locales.
   config_accessor :available_locales do
-    %w(en ca es eu it fi fr nl uk ru)
+    %w(en ca es eu fi fr gl it nl pt pr-BR ru sv uk)
+  end
+
+  # Exposes a configuration option: an array of symbols representing processors
+  # that will be automatically executed when a content is parsed or rendered.
+  #
+  # A content processor is a concept to refer to a set of two classes:
+  # the content parser class and the content renderer class.
+  # e.g. If we register a content processor named `user`:
+  #
+  #   Decidim.content_processors += [:user]
+  #
+  # we must declare the following classes:
+  #
+  #   Decidim::ContentParsers::UserParser < BaseParser
+  #   Decidim::ContentRenderers::UserRenderer < BaseRenderer
+  config_accessor :content_processors do
+    []
   end
 
   # Exposes a configuration option: The application default locale.
@@ -143,12 +166,54 @@ module Decidim
     true
   end
 
+  # Allow organization's administrators to track newsletter links
+  config_accessor :track_newsletter_links do
+    true
+  end
+
   # 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
   # environments, but in different folders.
   config_accessor :base_uploads_path
 
+  # Public: Registers a global engine. This method is intended to be used
+  # by feature engines that also offer unscoped functionality
+  #
+  # name    - The name of the engine to register. Should be unique.
+  # engine  - The engine to register.
+  # options - Options to pass to the engine.
+  #           :at - The route to mount the engine to.
+  #
+  # Returns nothing.
+  def self.register_global_engine(name, engine, options = {})
+    return if global_engines.keys.include?(name)
+
+    options[:at] ||= "/#{name}"
+
+    global_engines[name.to_sym] = {
+      at: options[:at],
+      engine: engine
+    }
+  end
+
+  # Semiprivate: Removes a global engine from the registry. Mostly used on testing,
+  # no real reason to use this on production.
+  #
+  # name - The name of the global engine to remove.
+  #
+  # Returns nothing.
+  def self.unregister_global_engine(name)
+    global_engines.delete(name.to_sym)
+  end
+
+  # Public: Finds all registered engines via the 'register_global_engine' method.
+  #
+  # Returns an Array[::Rails::Engine]
+  def self.global_engines
+    @global_engines ||= {}
+  end
+
   # Public: Registers a feature, usually held in an external library or in a
   # separate folder in the main repository. Exposes a DSL defined by
   # `Decidim::FeatureManifest`.

data/lib/decidim/core/api/author_interface.rb

@@ -7,12 +7,12 @@ module Decidim
     description "An author"
 
     field :name, !types.String, "The author's name"
+    field :nickname, !types.String, "The author's nickname"
 
     field :avatarUrl, !types.String, "The author's avatar url"
-
-    field :isVerified, !types.Boolean, "Whether the author is verified or not"
+    field :profilePath, !types.String, "The author's profile path"
+    field :badge, !types.String, "The author's badge icon"
 
     field :deleted, !types.Boolean, "Whether the author's account has been deleted or not"
-    field :isUser, !types.Boolean, "Whether the author is a user or another kind of author (User Group)"
   end
 end

data/lib/decidim/core/api/user_group_type.rb

@@ -14,22 +14,24 @@ module Decidim
 
     field :name, !types.String, "The user group's name"
 
+    field :nickname, !types.String, "User groups have no nickname" do
+      resolve ->(obj, _args, _ctx) { UserGroupPresenter.new(obj).nickname }
+    end
+
     field :avatarUrl, !types.String, "The user's avatar url" do
-      resolve ->(obj, _args, _ctx) { obj.avatar.url }
+      resolve ->(obj, _args, _ctx) { UserGroupPresenter.new(obj).avatar_url }
     end
 
-    field :isVerified, !types.Boolean, "Whether the user group is verified or not" do
-      resolve lambda { |obj, _args, _ctx|
-        obj.verified?
-      }
+    field :profilePath, !types.String, "The user's profile url" do
+      resolve ->(obj, _args, _ctx) { UserGroupPresenter.new(obj).profile_path }
     end
 
     field :deleted, !types.Boolean, "Whether the user group's has been deleted or not" do
-      resolve ->(_obj, _args, _ctx) { false }
+      resolve ->(obj, _args, _ctx) { UserGroupPresenter.new(obj).deleted? }
     end
 
-    field :isUser, !types.Boolean, "User groups are not users" do
-      resolve ->(_obj, _args, _ctx) { false }
+    field :badge, !types.String, "A badge for the user group" do
+      resolve ->(obj, _args, _ctx) { UserGroupPresenter.new(obj).badge }
     end
   end
 end

data/lib/decidim/core/api/user_type.rb

@@ -12,22 +12,28 @@ module Decidim
 
     field :name, !types.String, "The user's name"
 
+    field :nickname, !types.String, "The user's nickname" do
+      resolve ->(obj, _args, _ctx) { UserPresenter.new(obj).nickname }
+    end
+
     field :avatarUrl, !types.String, "The user's avatar url" do
-      resolve ->(obj, _args, _ctx) { obj.avatar.url }
+      resolve ->(obj, _args, _ctx) { UserPresenter.new(obj).avatar_url(:thumb) }
+    end
+
+    field :profilePath, !types.String, "The user's profile url" do
+      resolve ->(obj, _args, _ctx) { UserPresenter.new(obj).profile_path }
     end
 
     field :organizationName, !types.String, "The user's organization name" do
       resolve ->(obj, _args, _ctx) { obj.organization.name }
     end
 
-    field :isVerified, !types.Boolean, "Whether the author is verified or not" do
-      resolve ->(_obj, _args, _ctx) { false }
+    field :deleted, !types.Boolean, "Whether the user's account has been deleted or not" do
+      resolve ->(obj, _args, _ctx) { UserPresenter.new(obj).deleted? }
     end
 
-    field :deleted, !types.Boolean, "Whether the user's account has been deleted or not", property: :deleted?
-
-    field :isUser, !types.Boolean, "User groups are not users" do
-      resolve ->(_obj, _args, _ctx) { true }
+    field :badge, !types.String, "A badge for the user group" do
+      resolve ->(obj, _args, _ctx) { UserPresenter.new(obj).badge }
     end
   end
 end

data/lib/decidim/core/engine.rb

@@ -56,6 +56,7 @@ module Decidim
       end
 
       initializer "decidim.assets" do |app|
+        app.config.assets.paths << File.expand_path("../../../app/assets/stylesheets", __dir__)
         app.config.assets.precompile += %w(decidim_core_manifest.js)
 
         Decidim.feature_manifests.each do |feature|
@@ -107,19 +108,14 @@ module Decidim
           Geocoder.configure(
             # geocoding service (see below for supported options):
             lookup: :here,
-
             # IP address geocoding service (see below for supported options):
             # :ip_lookup => :maxmind,
-
             # to use an API key:
             api_key: [Decidim.geocoder&.fetch(:here_app_id), Decidim.geocoder&.fetch(:here_app_code)]
-
             # geocoding service request timeout, in seconds (default 3):
             # :timeout => 5,
-
             # set default units to kilometers:
             # :units => :km,
-
             # caching (see below for details):
             # :cache => Redis.new,
             # :cache_prefix => "..."
@@ -203,6 +199,12 @@ module Decidim
         end
       end
 
+      initializer "decidim.content_processors" do |_app|
+        Decidim.configure do |config|
+          config.content_processors += [:user]
+        end
+      end
+
       initializer "paper_trail" do
         PaperTrail.config.track_associations = false
       end

data/lib/decidim/core/test.rb

@@ -13,9 +13,9 @@ require "decidim/core/test/shared_examples/announcements_examples"
 require "decidim/core/test/shared_examples/process_announcements_examples"
 require "decidim/core/test/shared_examples/reportable"
 require "decidim/core/test/shared_examples/reports_examples"
-require "decidim/core/test/shared_examples/manage_moderations_examples"
 require "decidim/core/test/shared_examples/paginated_resource_examples"
 require "decidim/core/test/shared_examples/errors"
 require "decidim/core/test/shared_examples/scope_helper_examples"
 require "decidim/core/test/shared_examples/user_localised_email_examples"
 require "decidim/core/test/shared_examples/follows_examples"
+require "decidim/core/test/shared_examples/simple_event"

data/lib/decidim/core/test/factories.rb

@@ -11,6 +11,10 @@ FactoryBot.define do
     "#{Faker::Name.name} #{n}"
   end
 
+  sequence(:nickname) do |n|
+    "#{Faker::Lorem.characters(rand(1..10))}_#{n}"
+  end
+
   sequence(:email) do |n|
     "user#{n}@example.org"
   end
@@ -58,6 +62,8 @@ FactoryBot.define do
     official_img_header { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
     official_img_footer { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
     official_url { Faker::Internet.url }
+    highlighted_content_banner_enabled false
+    enable_omnipresent_banner false
   end
 
   factory :user, class: "Decidim::User" do
@@ -65,10 +71,13 @@ FactoryBot.define do
     password "password1234"
     password_confirmation "password1234"
     name { generate(:name) }
+    nickname { generate(:nickname) }
     organization
     locale { organization.default_locale }
     tos_agreement "1"
     avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
+    personal_url { Faker::Internet.url }
+    about { Faker::Lorem.paragraph(2) }
 
     trait :confirmed do
       confirmed_at { Time.current }
@@ -87,57 +96,16 @@ FactoryBot.define do
       roles { ["user_manager"] }
     end
 
-    trait :process_admin do
-      transient do
-        participatory_process { create(:participatory_process) }
-      end
-
-      organization { participatory_process.organization }
-
-      after(:create) do |user, evaluator|
-        create :participatory_process_user_role,
-               user: user,
-               participatory_process: evaluator.participatory_process,
-               role: :admin
-      end
-    end
-
-    trait :process_collaborator do
-      transient do
-        participatory_process { create(:participatory_process) }
-      end
-
-      organization { participatory_process.organization }
-
-      after(:create) do |user, evaluator|
-        create :participatory_process_user_role,
-               user: user,
-               participatory_process: evaluator.participatory_process,
-               role: :collaborator
-      end
-    end
-
-    trait :process_moderator do
-      transient do
-        participatory_process { create(:participatory_process) }
-      end
-
-      organization { participatory_process.organization }
-
-      after(:create) do |user, evaluator|
-        create :participatory_process_user_role,
-               user: user,
-               participatory_process: evaluator.participatory_process,
-               role: :moderator
-      end
-    end
-
     trait :managed do
       email { "" }
       password { "" }
       password_confirmation { "" }
       managed { true }
     end
+
+    trait :officialized do
+      officialized_at { Time.zone.now }
+    end
   end
 
   factory :participatory_process_user_role, class: "Decidim::ParticipatoryProcessUserRole" do
@@ -218,6 +186,8 @@ FactoryBot.define do
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
     file { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
     attached_to { build(:participatory_process) }
+    content_type { "image/jpeg" }
+    file_size { 108_908 }
 
     trait :with_image do
       file { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
@@ -225,6 +195,8 @@ FactoryBot.define do
 
     trait :with_pdf do
       file { Decidim::Dev.test_file("Exampledocument.pdf", "application/pdf") }
+      content_type { "application/pdf" }
+      file_size { 17_525 }
     end
   end
 
@@ -291,6 +263,10 @@ FactoryBot.define do
   factory :moderation, class: "Decidim::Moderation" do
     reportable { build(:dummy_resource) }
     participatory_space { reportable.feature.participatory_space }
+
+    trait :hidden do
+      hidden_at { 1.day.ago }
+    end
   end
 
   factory :report, class: "Decidim::Report" do