decidim-core 0.13.1 → 0.14.1

data/lib/decidim/coauthorable.rb

@@ -63,6 +63,7 @@ module Decidim
       def add_coauthor(user, extra_attrs = {})
         attrs = { coauthorable: self, author: user }
         Decidim::Coauthorship.create!(attrs.merge(extra_attrs))
+        Decidim::Follow.create!(followable: self, user: user) unless followers.exists?(user.id)
       end
     end
   end

data/lib/decidim/content_block_manifest.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a manifest for content blocks.
+  #
+  # A content block is a view section in a given page. Those sections can be
+  # registered by Decidim modules, and are configurable and sortable. They are a
+  # useful way to customize a given page, without having to rely on overwriting
+  # the views files. Also, this system is more powerful than basic view hooks
+  # (see the `ViewHooks` class for reference), as view hooks don't have a way to
+  # explicitly control the order of the hooked views.
+  #
+  # Content blocks are intended to be used in the home page, for example.
+  #
+  # A content block has a set of settings and an associated `cell` that will
+  # handle the layout logic. They can also have attached images that can be used
+  # as background images, for example. You must explicitly specify the number of
+  # images the block will have (this means the number of attached images cannot
+  # be configurable). Each content block is identified by a name, which has to
+  # be unique per scope.
+  class ContentBlockManifest
+    include ActiveModel::Model
+    include Virtus.model
+
+    attribute :name, Symbol
+    attribute :public_name_key, String
+    attribute :cell, String
+    attribute :settings_form_cell, String
+    attribute :images, Array[Hash]
+
+    validates :name, :cell, :public_name_key, presence: true
+    validates :settings_form_cell, presence: true, if: :has_settings?
+    validate :image_names_are_unique
+    validate :images_have_an_uploader
+
+    def has_settings?
+      settings.attributes.any?
+    end
+
+    def settings(&block)
+      @settings ||= SettingsManifest.new
+      yield(@settings) if block
+      @settings
+    end
+
+    private
+
+    def image_names_are_unique
+      image_names = images.map { |image| image[:name] }
+      errors.add(:images, "names must be unique per manifest") if image_names.count != image_names.uniq.count
+    end
+
+    def images_have_an_uploader
+      uploaders = images.map { |image| image[:uploader].presence }
+      errors.add(:images, "must have an uploader") if uploaders.compact.count != images.count
+    end
+  end
+end

data/lib/decidim/content_block_registry.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a registry for content blocks. Check the docs on the
+  # `ContentBlockManifest` class to learn how they work.
+  #
+  # In order to register a content block, you can follow this example:
+  #
+  #     Decidim.content_blocks.register(:homepage, :global_stats) do |content_block|
+  #       content_block.cell = "decidim/content_blocks/stats_block"
+  #       content_block.public_name_key = "decidim.content_blocks.stats_block.name"
+  #       content_block.settings_form_cell = "decidim/content_blocks/stats_block_settings_form"
+  #
+  #       content_block.settings do |settings|
+  #         settings.attribute :minimum_priority_level,
+  #                            type: :integer
+  #                            default: lambda { StatsRegistry::HIGH_PRIORITY }
+  #       end
+  #     end
+  #
+  # Content blocks can also register attached images. Here's an example of a
+  # content block with 4 attached images:
+  #
+  #     Decidim.content_blocks.register(:homepage, :carousel) do |content_block|
+  #       content_block.cell = "decidim/content_blocks/carousel_block"
+  #       content_block.public_name_key = "decidim.content_blocks.carousel_block.name"
+  #
+  #       content_block.images = [
+  #         {
+  #           name: :image_1,
+  #           uploader: "Decidim::ImageUploader"
+  #         },
+  #         {
+  #           name: :image_2,
+  #           uploader: "Decidim::ImageUploader"
+  #         }
+  #       ]
+  #     end
+  #
+  # You will probably want to register your content blocks in an initializer in
+  # the `engine.rb` file of your module.
+  class ContentBlockRegistry
+    # Public: Registers a content block for the home page.
+    #
+    # scope - a symbol or string representing the scope of the content block.
+    #         Will be persisted as a string.
+    # name - a symbol representing the name of the content block
+    # &block - The content block definition.
+    #
+    # Returns nothing. Raises an error if there's already a content block
+    # registered with that name.
+    def register(scope, name)
+      scope = scope.to_s
+      block_exists = content_blocks[scope].any? { |content_block| content_block.name == name }
+
+      if block_exists
+        raise(
+          ContentBlockAlreadyRegistered,
+          "There's a content block already registered with the name `:#{name}` for the scope `:#{scope}, must be unique"
+        )
+      end
+
+      content_block = ContentBlockManifest.new(name: name)
+
+      yield(content_block)
+
+      content_block.validate!
+      content_blocks[scope].push(content_block)
+    end
+
+    def for(scope)
+      content_blocks[scope.to_s]
+    end
+
+    def all
+      content_blocks
+    end
+
+    class ContentBlockAlreadyRegistered < StandardError; end
+
+    private
+
+    def content_blocks
+      @content_blocks ||= Hash.new { |h, k| h[k] = [] }
+    end
+  end
+end

data/lib/decidim/content_parsers.rb

@@ -4,5 +4,6 @@ module Decidim
   module ContentParsers
     autoload :BaseParser, "decidim/content_parsers/base_parser"
     autoload :UserParser, "decidim/content_parsers/user_parser"
+    autoload :HashtagParser, "decidim/content_parsers/hashtag_parser"
   end
 end

data/lib/decidim/content_parsers/hashtag_parser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentParsers
+    # A parser that searches user mentions in content.
+    #
+    # A word starting with `#` will be considered as a possible hashtagging if
+    # they only contains letters, numbers or underscores. If the `#` is
+    # followed with an underscore, then it is not considered.
+    #
+    # @see BaseParser Examples of how to use a content parser
+    class HashtagParser < BaseParser
+      Metadata = Struct.new(:hashtags)
+
+      # Replaces found hashtags matching a name of an existing
+      # hashtag with a global id.
+      #
+      # @return [String] the content with the hashtags replaced by a global id
+      def rewrite
+        content.gsub(Decidim::Hashtag::HASHTAG_REGEX) do |match|
+          if (hashtag = Decidim::Hashtag.find_or_create_by(organization: context[:current_organization], name: Regexp.last_match[2].downcase))
+            Regexp.last_match[1] + hashtag.to_global_id.to_s
+          else
+            match
+          end
+        end
+      end
+
+      def metadata
+        Metadata.new(
+          Decidim::Hashtag.where(organization: context[:current_organization], name: content.scan(Decidim::Hashtag::HASHTAG_REGEX).flatten)
+        )
+      end
+    end
+  end
+end

data/lib/decidim/content_processor.rb

@@ -60,6 +60,17 @@ module Decidim
       Result.new(parsed[:rewrite], parsed[:metadata])
     end
 
+    def self.parse_with_processor(_type, content, context)
+      parsed = 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
+      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.
     #

data/lib/decidim/content_renderers.rb

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

data/lib/decidim/content_renderers/hashtag_renderer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ContentRenderers
+    # A renderer that searches Global IDs representing hashtags in content
+    # and replaces it with a link to their detail page with the name.
+    #
+    # e.g. gid://<APP_NAME>/Decidim::Hashtag/1
+    #
+    # @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+)}
+
+      # Replaces found Global IDs matching an existing hashtag with
+      # a link to their detail page. The Global IDs representing an
+      # invalid Decidim::Hashtag are replaced with an empty string.
+      #
+      # @return [String] the content ready to display (contains HTML)
+      def render
+        content.gsub(GLOBAL_ID_REGEX) do |hashtag_gid|
+          begin
+            hashtag = GlobalID::Locator.locate(hashtag_gid)
+            Decidim::HashtagPresenter.new(hashtag).display_hashtag
+          rescue ActiveRecord::RecordNotFound => _ex
+            ""
+          end
+        end
+      end
+
+      def render_without_link
+        content.gsub(GLOBAL_ID_REGEX) do |hashtag_gid|
+          begin
+            hashtag = GlobalID::Locator.locate(hashtag_gid)
+            Decidim::HashtagPresenter.new(hashtag).display_hashtag_name
+          rescue ActiveRecord::RecordNotFound => _ex
+            ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/core.rb

@@ -3,7 +3,6 @@
 require "decidim/core/engine"
 require "decidim/core/api"
 require "decidim/core/version"
-
 # Decidim configuration.
 module Decidim
   autoload :TranslatableAttributes, "decidim/translatable_attributes"
@@ -49,6 +48,8 @@ module Decidim
   autoload :EngineRouter, "decidim/engine_router"
   autoload :Events, "decidim/events"
   autoload :ViewHooks, "decidim/view_hooks"
+  autoload :ContentBlockRegistry, "decidim/content_block_registry"
+  autoload :ContentBlockManifest, "decidim/content_block_manifest"
   autoload :NewsletterEncryptor, "decidim/newsletter_encryptor"
   autoload :Searchable, "decidim/searchable"
   autoload :SearchResourceFieldsMapper, "decidim/search_resource_fields_mapper"
@@ -62,9 +63,10 @@ module Decidim
   autoload :DataPortabilitySerializers, "decidim/data_portability_serializers"
   autoload :DataPortabilityFileReader, "decidim/data_portability_file_reader"
   autoload :DataPortabilityFileZipper, "decidim/data_portability_file_zipper"
-
+  autoload :Gamification, "decidim/gamification"
+  autoload :Hashtag, "decidim/hashtag"
+  autoload :Hashtaggable, "decidim/hashtaggable"
   include ActiveSupport::Configurable
-
   # Loads seeds from all engines.
   def self.seed!
     # Faker needs to have the `:en` locale in order to work properly, so we
@@ -78,7 +80,17 @@ module Decidim
       railtie.load_seed
     end
 
-    Decidim.participatory_space_manifests.each(&:seed!)
+    participatory_space_manifests.each(&:seed!)
+    Gamification.badges.each do |badge|
+      puts "Setting random values for the \"#{badge.name}\" badge..."
+      User.all.find_each do |user|
+        Gamification::BadgeScore.find_or_create_by!(
+          user: user,
+          badge_name: badge.name,
+          value: Random.rand(0...20)
+        )
+      end
+    end
 
     I18n.available_locales = original_locale
   end
@@ -92,7 +104,7 @@ module Decidim
 
   # Exposes a configuration option: The application available locales.
   config_accessor :available_locales do
-    %w(en ca es es-PY eu fi fr gl it nl pt pt-BR ru sv uk)
+    %w(en ca es es-PY eu fi fr gl hu it nl pt pt-BR ru sv uk)
   end
 
   # Exposes a configuration option: an array of symbols representing processors
@@ -156,6 +168,11 @@ module Decidim
     "€"
   end
 
+  # Exposes a configuration option: The image uploader quality.
+  config_accessor :image_uploader_quality do
+    80
+  end
+
   # Exposes a configuration option: The maximum file size of an attachment.
   config_accessor :maximum_attachment_size do
     10.megabytes
@@ -212,7 +229,7 @@ module Decidim
   #
   # Returns nothing.
   def self.register_global_engine(name, engine, options = {})
-    return if global_engines.keys.include?(name)
+    return if global_engines.has_key?(name)
 
     options[:at] ||= "/#{name}"
 
@@ -354,6 +371,11 @@ module Decidim
     @view_hooks ||= ViewHooks.new
   end
 
+  # Public: Stores an instance of ContentBlockRegistry
+  def self.content_blocks
+    @content_blocks ||= ContentBlockRegistry.new
+  end
+
   # Public: Stores an instance of Traceability
   def self.traceability
     @traceability ||= Traceability.new

data/lib/decidim/core/api.rb

@@ -9,5 +9,6 @@ module Decidim
     autoload :CategorizableInterface, "decidim/api/categorizable_interface"
     autoload :ScopableInterface, "decidim/api/scopable_interface"
     autoload :AttachableInterface, "decidim/api/attachable_interface"
+    autoload :HashtagInterface, "decidim/api/hashtag_interface"
   end
 end

data/lib/decidim/core/engine.rb

@@ -200,7 +200,7 @@ module Decidim
 
       initializer "decidim.content_processors" do |_app|
         Decidim.configure do |config|
-          config.content_processors += [:user]
+          config.content_processors += [:user, :hashtag]
         end
       end
 
@@ -275,6 +275,57 @@ module Decidim
           resource.card = "decidim/user_profile"
         end
       end
+
+      initializer "decidim.core.content_blocks" do
+        Decidim.content_blocks.register(:homepage, :hero) do |content_block|
+          content_block.cell = "decidim/content_blocks/hero"
+          content_block.settings_form_cell = "decidim/content_blocks/hero_settings_form"
+          content_block.public_name_key = "decidim.content_blocks.hero.name"
+
+          content_block.images = [
+            {
+              name: :background_image,
+              uploader: "Decidim::HomepageImageUploader"
+            }
+          ]
+
+          content_block.settings do |settings|
+            settings.attribute :welcome_text, type: :text, translated: true
+          end
+        end
+
+        Decidim.content_blocks.register(:homepage, :sub_hero) do |content_block|
+          content_block.cell = "decidim/content_blocks/sub_hero"
+          content_block.public_name_key = "decidim.content_blocks.sub_hero.name"
+        end
+
+        Decidim.content_blocks.register(:homepage, :highlighted_content_banner) do |content_block|
+          content_block.cell = "decidim/content_blocks/highlighted_content_banner"
+          content_block.public_name_key = "decidim.content_blocks.highlighted_content_banner.name"
+        end
+
+        Decidim.content_blocks.register(:homepage, :how_to_participate) do |content_block|
+          content_block.cell = "decidim/content_blocks/how_to_participate"
+          content_block.public_name_key = "decidim.content_blocks.how_to_participate.name"
+        end
+
+        Decidim.content_blocks.register(:homepage, :stats) do |content_block|
+          content_block.cell = "decidim/content_blocks/stats"
+          content_block.public_name_key = "decidim.content_blocks.stats.name"
+        end
+
+        Decidim.content_blocks.register(:homepage, :footer_sub_hero) do |content_block|
+          content_block.cell = "decidim/content_blocks/footer_sub_hero"
+          content_block.public_name_key = "decidim.content_blocks.footer_sub_hero.name"
+        end
+      end
+
+      initializer "decidim.core.add_badges" do
+        Decidim::Gamification.register_badge(:invitations) do |badge|
+          badge.levels = [1, 5, 10, 30, 50]
+          badge.reset = ->(user) { Decidim::User.where(invited_by: user.id).count }
+        end
+      end
     end
   end
 end

data/lib/decidim/core/test.rb

@@ -24,3 +24,6 @@ require "decidim/core/test/shared_examples/simple_event"
 require "decidim/core/test/shared_examples/component_type"
 require "decidim/core/test/shared_examples/fingerprint_examples"
 require "decidim/core/test/shared_examples/searchable_results_examples"
+require "decidim/core/test/shared_examples/has_space_in_mcell_examples"
+require "decidim/core/test/shared_examples/railtie_examples"
+require "decidim/core/test/shared_examples/edit_link_shared_examples"

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

@@ -16,6 +16,10 @@ FactoryBot.define do
     "#{Faker::Lorem.characters(rand(1..10))}_#{n}"
   end
 
+  sequence(:hashtag_name) do |n|
+    "#{Faker::Lorem.characters(rand(1..10))}_#{n}"
+  end
+
   sequence(:email) do |n|
     "user#{n}@example.org"
   end
@@ -59,16 +63,14 @@ FactoryBot.define do
     github_handler { Faker::Hipster.word }
     sequence(:host) { |n| "#{n}.lvh.me" }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
-    welcome_text { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
-    homepage_image { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
     favicon { Decidim::Dev.test_file("icon.png", "image/png") }
     default_locale { Decidim.default_locale }
     available_locales { Decidim.available_locales }
     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
+    highlighted_content_banner_enabled { false }
+    enable_omnipresent_banner { false }
     tos_version { Time.current }
 
     trait :with_tos do
@@ -81,13 +83,13 @@ FactoryBot.define do
 
   factory :user, class: "Decidim::User" do
     email { generate(:email) }
-    password "password1234"
+    password { "password1234" }
     password_confirmation { password }
     name { generate(:name) }
     nickname { generate(:nickname) }
     organization
     locale { organization.default_locale }
-    tos_agreement "1"
+    tos_agreement { "1" }
     avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
     personal_url { Faker::Internet.url }
     about { Faker::Lorem.paragraph(2) }
@@ -104,7 +106,7 @@ FactoryBot.define do
     end
 
     trait :deleted do
-      email ""
+      email { "" }
       deleted_at { Time.current }
     end
 
@@ -124,7 +126,7 @@ FactoryBot.define do
     end
 
     trait :officialized do
-      officialized_at { Time.zone.now }
+      officialized_at { Time.current }
       officialized_as { Decidim::Faker::Localized.sentence(3) }
     end
   end
@@ -140,14 +142,14 @@ FactoryBot.define do
   end
 
   factory :user_group, class: "Decidim::UserGroup" do
-    name { Faker::Educator.unique.course }
+    sequence(:name) { |n| "#{Faker::Company.name} #{n}" }
     document_number { Faker::Number.number(8) + "X" }
     phone { Faker::PhoneNumber.phone_number }
     avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
     organization
 
     transient do
-      users []
+      users { [] }
     end
 
     trait :verified do
@@ -174,7 +176,7 @@ FactoryBot.define do
   end
 
   factory :identity, class: "Decidim::Identity" do
-    provider "facebook"
+    provider { "facebook" }
     sequence(:uid)
     user
     organization { user.organization }
@@ -191,7 +193,7 @@ FactoryBot.define do
     end
 
     trait :pending do
-      granted_at nil
+      granted_at { nil }
     end
   end
 
@@ -245,7 +247,7 @@ FactoryBot.define do
 
     name { Decidim::Faker::Localized.sentence(3) }
     participatory_space { create(:participatory_process, organization: organization) }
-    manifest_name "dummy"
+    manifest_name { "dummy" }
     published_at { Time.current }
 
     trait :unpublished do
@@ -266,7 +268,7 @@ FactoryBot.define do
   factory :scope, class: "Decidim::Scope" do
     name { Decidim::Faker::Localized.literal(generate(:scope_name)) }
     code { generate(:scope_code) }
-    scope_type
+    scope_type { create(:scope_type, organization: organization) }
     organization { parent ? parent.organization : build(:organization) }
   end
 
@@ -335,7 +337,7 @@ FactoryBot.define do
   factory :report, class: "Decidim::Report" do
     moderation
     user { build(:user, organization: moderation.reportable.organization) }
-    reason "spam"
+    reason { "spam" }
   end
 
   factory :impersonation_log, class: "Decidim::ImpersonationLog" do
@@ -419,7 +421,7 @@ FactoryBot.define do
     application { build(:oauth_application) }
     token { SecureRandom.hex(32) }
     expires_in { 1.month.from_now }
-    created_at { Time.zone.now }
+    created_at { Time.current }
     scopes { "public" }
   end
 
@@ -432,6 +434,19 @@ FactoryBot.define do
     locale { I18n.locale }
     scope { resource.scope }
     content_a { Faker::Lorem.sentence }
-    datetime { DateTime.current }
+    datetime { Time.current }
+  end
+
+  factory :content_block, class: "Decidim::ContentBlock" do
+    organization
+    scope { :homepage }
+    manifest_name { :hero }
+    weight { 1 }
+    published_at { Time.current }
+  end
+
+  factory :hashtag, class: "Decidim::Hashtag" do
+    name { generate(:hashtag_name) }
+    organization
   end
 end