decidim-core 0.18.1 → 0.19.0

data/lib/decidim/amendable.rb

@@ -12,14 +12,14 @@ module Decidim
                foreign_type: "decidim_amendable_type",
                class_name: "Decidim::Amendment"
 
-      # resource.emendations : resources that have amend the resource
+      # resource.emendations : resources that have amended the original resource
       has_many :emendations,
                through: :amendments,
                source: :emendation,
                source_type: name,
                inverse_of: :emendations
 
-      # resource.amenders :  users that have emendations for the resource
+      # resource.amenders : users that have created emendations for the original resource
       has_many :amenders,
                through: :amendments,
                source: :amender
@@ -35,6 +35,34 @@ module Decidim
 
       scope :only_amendables, -> { where.not(id: joins(:amendable)) }
       scope :only_emendations, -> { where(id: joins(:amendable)) }
+      # retrieves resources that are emendations and visible to the user
+      # based on the component's amendments settings.
+      scope :only_visible_emendations_for, lambda { |user, component|
+        return only_emendations unless component.settings.amendments_enabled
+
+        case component.current_settings.amendments_visibility
+        when "participants"
+          return none unless user
+
+          where(id: joins(:amendable).where("decidim_amendments.decidim_user_id = ?", user.id))
+        else # Assume 'all'
+          only_emendations
+        end
+      }
+      # retrieves both resources that are amendables and emendations filtering out the emendations
+      # that are not visible to the user based on the component's amendments settings.
+      scope :amendables_and_visible_emendations_for, lambda { |user, component|
+        return all unless component.settings.amendments_enabled
+
+        case component.current_settings.amendments_visibility
+        when "participants"
+          return only_amendables unless user
+
+          where.not(id: joins(:amendable).where.not("decidim_amendments.decidim_user_id = ?", user.id))
+        else # Assume 'all'
+          all
+        end
+      }
     end
 
     class_methods do
@@ -53,46 +81,92 @@ module Decidim
       end
     end
 
+    # Returns the fields that can be amended.
     def amendable_fields
       self.class.amendable_options[:fields]
     end
 
+    # Returns the form used for the validation and creation of the emendation.
     def amendable_form
       self.class.amendable_options[:form].constantize
     end
 
-    def amendable_type
-      resource_manifest.model_class_name
-    end
-
+    # Returns the polymorphic association.
     def amendment
       associated_resource = emendation? ? :emendation : :amendable
 
       Decidim::Amendment.find_by(associated_resource => id)
     end
 
+    # Checks if the resource HAS amended another resource.
+    # Returns true or false.
     def emendation?
       amendable.present?
     end
 
+    # Checks if the resource CAN be amended by other resources.
+    # Returns true or false.
     def amendable?
       amendable.blank?
     end
 
-    def resource_state
+    # Returns the state of the amendment or the state of the resource.
+    def state
+      return amendment.state if emendation?
+
       attributes["state"]
     end
 
-    def emendation_state
-      return resource_state if resource_state == "withdrawn"
+    # Returns the linked resource to or from this model
+    # for the given resource name and link name.
+    # See Decidim::Resourceable#link_resources
+    def linked_promoted_resource
+      linked_resources(self.class, "created_from_rejected_emendation").first
+    end
+
+    # Returns the emendations of an amendable that are visible to the user
+    # based on the component's amendments settings and filtering out the "drafts".
+    def visible_emendations_for(user)
+      pubslished_emendations = emendations.published
+      return pubslished_emendations unless component.settings.amendments_enabled
+
+      case component.current_settings.amendments_visibility
+      when "participants"
+        return self.class.none unless user
 
-      amendment.state
+        pubslished_emendations.where("decidim_amendments.decidim_user_id = ?", user.id)
+      else # Assume 'all'
+        pubslished_emendations
+      end
     end
 
-    def state
-      return emendation_state if emendation?
+    # Returns the amendments (polymorphic association) of the emendations that
+    # are visible to the user based on the component's amendments settings.
+    def visible_amendments_for(user)
+      amendments.where(emendation: visible_emendations_for(user))
+    end
 
-      resource_state
+    # Handles the logic to assign an author to the resource, be it Authorable or Coauthorable.
+    def add_author(author, user_group = nil)
+      if is_a?(Decidim::Authorable)
+        if persisted?
+          update(author: user_group || author)
+        else
+          self.author = user_group || author
+        end
+      else # Assume is_a?(Decidim::Coauthorable)
+        coauthorships.clear
+        add_coauthor(author, user_group: user_group)
+      end
+    end
+
+    # Returns an Array of Decidim::User.
+    def notifiable_identities
+      if is_a?(Decidim::Authorable)
+        [author]
+      else # Assume is_a?(Decidim::Coauthorable)
+        super
+      end
     end
   end
 end

data/lib/decidim/attributes/localized_date.rb

@@ -7,10 +7,15 @@ module Decidim
     class LocalizedDate < Virtus::Attribute
       def coerce(value)
         return value unless value.is_a?(String)
+
         Date.strptime(value, I18n.t("date.formats.decidim_short"))
       rescue ArgumentError
         nil
       end
+
+      def type
+        Axiom::Types::Date
+      end
     end
   end
 end

data/lib/decidim/attributes/time_with_zone.rb

@@ -7,10 +7,15 @@ module Decidim
     class TimeWithZone < Virtus::Attribute
       def coerce(value)
         return value unless value.is_a?(String)
+
         Time.zone.strptime(value, I18n.t("time.formats.decidim_short"))
       rescue ArgumentError
         nil
       end
+
+      def type
+        Axiom::Types::Time
+      end
     end
   end
 end

data/lib/decidim/authorable.rb

@@ -36,16 +36,19 @@ module Decidim
 
       def verified_user_group
         return unless user_group
+
         errors.add :user_group, :invalid unless user_group.verified?
       end
 
       def user_group_membership
         return unless user_group
+
         errors.add :user_group, :invalid unless user_group.users.include? author
       end
 
       def author_belongs_to_organization
         return if !author || !organization
+
         errors.add(:author, :invalid) unless author == organization || author.respond_to?(:organization) && author.organization == organization
       end
     end

data/lib/decidim/authorization_form_builder.rb

@@ -39,7 +39,7 @@ module Decidim
       return hidden_field(name) if name.to_s == "handler_name"
 
       case type.name
-      when "Date", "Decidim::Attributes::LocalizedDate"
+      when "Date", "Time"
         date_field name
       else
         text_field name
@@ -58,7 +58,7 @@ module Decidim
 
     def public_attributes
       form_attributes.inject({}) do |all, attribute|
-        all.update(attribute.name => attribute.class)
+        all.update(attribute.name => attribute.type.primitive)
       end
     end
 

data/lib/decidim/component_manifest.rb

@@ -83,6 +83,7 @@ module Decidim
     # Returns nothing.
     def run_hooks(event_name, context = nil)
       return unless hooks[event_name]
+
       hooks[event_name.to_sym].each do |hook|
         hook.call(context)
       end
@@ -146,6 +147,7 @@ module Decidim
     # Returns nothing.
     def exports(name, &block)
       return unless name
+
       @exports ||= []
       @exports << [name, block]
       @export_manifests = nil

data/lib/decidim/content_parsers.rb

@@ -5,5 +5,7 @@ module Decidim
     autoload :BaseParser, "decidim/content_parsers/base_parser"
     autoload :UserParser, "decidim/content_parsers/user_parser"
     autoload :HashtagParser, "decidim/content_parsers/hashtag_parser"
+    autoload :NewlineParser, "decidim/content_parsers/newline_parser"
+    autoload :LinkParser, "decidim/content_parsers/link_parser"
   end
 end

data/lib/decidim/content_parsers/hashtag_parser.rb

@@ -18,7 +18,7 @@ module Decidim
 
       # Matches a hashtag if it starts with a letter or number
       # and only contains letters, numbers or underscores.
-      HASHTAG_REGEX = /\B#([[:alnum:]](?:[[:alnum:]]|_)*)\b/i
+      HASHTAG_REGEX = /\B#([[:alnum:]](?:[[:alnum:]]|_)*)\b/i.freeze
 
       # Replaces hashtags name with new or existing hashtags models global ids.
       #

data/lib/decidim/content_parsers/link_parser.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentParsers
+    # As recommended here: decidim-core/lib/decidim/content_processor.rb
+    # We are declaring the class and leaving it empty as we only want the renderer.
+    class LinkParser < BaseParser
+    end
+  end
+end

data/lib/decidim/content_parsers/newline_parser.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentParsers
+    # A parser that searches newline escape sequences in content.
+    #
+    # The escape sequences `\r\n` and `\r` will be replaced by `\n`.
+    #
+    # @see BaseParser Examples of how to use a content parser
+    class NewlineParser < BaseParser
+      ESCAPE_SEQUENCES = ["\r\n", "\r"].freeze
+      REGEX = Regexp.union(ESCAPE_SEQUENCES)
+
+      # @return [String] the content with the escape sequences replaced.
+      def rewrite
+        content.gsub(REGEX, "\n")
+      end
+    end
+  end
+end

data/lib/decidim/content_parsers/user_parser.rb

@@ -18,7 +18,7 @@ module Decidim
 
       # Matches a nickname if it starts with a letter or number
       # and only contains letters, numbers or underscores.
-      MENTION_REGEX = /\B@([a-zA-Z0-9]\w*)\b/
+      MENTION_REGEX = /\B@([a-zA-Z0-9]\w*)\b/.freeze
 
       # Replaces found mentions matching a nickname of an existing
       # user in the current organization with a global id. Other

data/lib/decidim/content_processor.rb

@@ -64,6 +64,7 @@ module Decidim
       parsed = if content.is_a?(Hash)
                  Decidim.content_processors.each_with_object(rewrite: content, metadata: {}) do |type, result|
                    next unless type == :hashtag
+
                    result[:rewrite].each do |key, value|
                      parser = parser_klass(type).constantize.new(value, context)
                      result[:rewrite][key] = parser.rewrite
@@ -73,6 +74,7 @@ module Decidim
                else
                  Decidim.content_processors.each_with_object(rewrite: content, metadata: {}) do |type, result|
                    next unless type == :hashtag
+
                    parser = parser_klass(type).constantize.new(result[:rewrite], context)
                    result[:rewrite] = parser.rewrite
                    result[:metadata][type] = parser.metadata

data/lib/decidim/content_renderers.rb

@@ -5,5 +5,6 @@ module Decidim
     autoload :BaseRenderer, "decidim/content_renderers/base_renderer"
     autoload :UserRenderer, "decidim/content_renderers/user_renderer"
     autoload :HashtagRenderer, "decidim/content_renderers/hashtag_renderer"
+    autoload :LinkRenderer, "decidim/content_renderers/link_renderer"
   end
 end

data/lib/decidim/content_renderers/hashtag_renderer.rb

@@ -10,7 +10,7 @@ module Decidim
     # @see BaseRenderer Examples of how to use a content renderer
     class HashtagRenderer < BaseRenderer
       # Matches a global id representing a Decidim::Hashtag
-      GLOBAL_ID_REGEX = %r{gid:\/\/[\w-]*\/Decidim::Hashtag\/(\d+)\/?(_?)([[:alnum:]](?:[[:alnum:]]|_)*)?\b}
+      GLOBAL_ID_REGEX = %r{gid:\/\/[\w-]*\/Decidim::Hashtag\/(\d+)\/?(_?)([[:alnum:]](?:[[:alnum:]]|_)*)?\b}.freeze
 
       # Replaces found Global IDs matching an existing hashtag with
       # a link to their detail page. The Global IDs representing an

data/lib/decidim/content_renderers/link_renderer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    # A renderer that converts URLs to links and strips attributes in anchors.
+    #
+    # Examples:
+    # `<a href="http://urls.net" onmouseover="alert('hello')">URLs</a>`
+    # Gets rendered as:
+    # `<a href="https://decidim.org" target="_blank" rel="noopener">https://decidim.org</a>`
+    # And:
+    # `<a href="javascript:document.cookies">click me</a>`
+    # Gets rendered as:
+    # `click me`
+    #
+    # @see BaseRenderer Examples of how to use a content renderer
+    class LinkRenderer < BaseRenderer
+      # @return [String] the content ready to display (contains HTML)
+      def render(options = { target: "_blank", rel: "noopener" })
+        Anchored::Linker.auto_link(content, options)
+      end
+    end
+  end
+end

data/lib/decidim/content_renderers/user_renderer.rb

@@ -10,7 +10,7 @@ module Decidim
     # @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://\S+/Decidim::User/\d+}
+      GLOBAL_ID_REGEX = %r{gid://\S+/Decidim::User/\d+}.freeze
 
       # Replaces found Global IDs matching an existing user with
       # a link to their profile. The Global IDs representing an
@@ -21,7 +21,7 @@ module Decidim
         content.gsub(GLOBAL_ID_REGEX) do |user_gid|
           user = GlobalID::Locator.locate(user_gid)
           Decidim::UserPresenter.new(user).display_mention
-        rescue ActiveRecord::RecordNotFound => _ex
+        rescue ActiveRecord::RecordNotFound => _e
           ""
         end
       end

data/lib/decidim/core.rb

@@ -79,6 +79,7 @@ module Decidim
   autoload :IoEncoder, "decidim/io_encoder"
   autoload :HasResourcePermission, "decidim/has_resource_permission"
   autoload :PermissionsRegistry, "decidim/permissions_registry"
+  autoload :Randomable, "decidim/randomable"
 
   include ActiveSupport::Configurable
   # Loads seeds from all engines.
@@ -275,6 +276,16 @@ module Decidim
     %w(admin user_manager)
   end
 
+  # Exposes a configuration option: An Array of Strings that serve both as
+  # locale keys and values to construct the input collection in
+  # Decidim::Amendment::VisibilityStepSetting::options.
+  # This collection is used in Decidim::Admin::SettingsHelper to generate a
+  # radio buttons collection input field form for a Decidim::Component
+  # step setting :amendments_visibility.
+  config_accessor :amendments_visibility_options do
+    %w(all participants)
+  end
+
   # Public: Registers a global engine. This method is intended to be used
   # by component engines that also offer unscoped functionality
   #

data/lib/decidim/core/engine.rb

@@ -185,35 +185,16 @@ module Decidim
 
       initializer "decidim.notifications" do
         Decidim::EventsManager.subscribe(/^decidim\.events\./) do |event_name, data|
-          EmailNotificationGeneratorJob.perform_later(
-            event_name,
-            data[:event_class],
-            data[:resource],
-            data[:followers],
-            data[:affected_users],
-            data[:extra]
-          )
-          NotificationGeneratorJob.perform_later(
-            event_name,
-            data[:event_class],
-            data[:resource],
-            data[:followers],
-            data[:affected_users],
-            data[:extra]
-          )
+          EventPublisherJob.perform_later(event_name, data)
         end
       end
 
       initializer "decidim.content_processors" do |_app|
         Decidim.configure do |config|
-          config.content_processors += [:user, :hashtag]
+          config.content_processors += [:user, :hashtag, :link]
         end
       end
 
-      initializer "paper_trail" do
-        PaperTrail.config.track_associations = false
-      end
-
       initializer "add_cells_view_paths" do
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Core::Engine.root}/app/cells")
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Core::Engine.root}/app/cells/amendable")
@@ -246,13 +227,6 @@ module Decidim
           default_scopes :public
           optional_scopes []
 
-          # Change the native redirect uri for client apps
-          # When clients register with the following redirect uri, they won't be redirected to any server and the authorization code will be displayed within the provider
-          # The value can be any string. Use nil to disable this feature. When disabled, clients must provide a valid URL
-          # (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
-          #
-          native_redirect_uri "urn:ietf:wg:oauth:2.0:oob"
-
           # Forces the usage of the HTTPS protocol in non-native redirect uris (enabled
           # by default in non-development environments). OAuth2 delegates security in
           # communication to the HTTPS protocol so it is wise to keep this enabled.