decidim-core 0.20.0 → 0.23.1.rc1

data/lib/decidim/core/api.rb

@@ -6,9 +6,17 @@ module Decidim
     autoload :ComponentInterface, "decidim/api/component_interface"
     autoload :AuthorInterface, "decidim/api/author_interface"
     autoload :AuthorableInterface, "decidim/api/authorable_interface"
+    autoload :CoauthorableInterface, "decidim/api/coauthorable_interface"
     autoload :CategorizableInterface, "decidim/api/categorizable_interface"
     autoload :ScopableInterface, "decidim/api/scopable_interface"
     autoload :AttachableInterface, "decidim/api/attachable_interface"
     autoload :HashtagInterface, "decidim/api/hashtag_interface"
+    autoload :ParticipatorySpaceResourceableInterface, "decidim/api/participatory_space_resourceable_interface"
+    autoload :FingerprintInterface, "decidim/api/fingerprint_interface"
+    autoload :AmendableInterface, "decidim/api/amendable_interface"
+    autoload :AmendableEntityInterface, "decidim/api/amendable_entity_interface"
+    autoload :TraceableInterface, "decidim/api/traceable_interface"
+    autoload :TimestampsInterface, "decidim/api/timestamps_interface"
+    autoload :EndorsableInterface, "decidim/api/endorsable_interface"
   end
 end

data/lib/decidim/core/engine.rb

@@ -59,12 +59,14 @@ module Decidim
 
       initializer "decidim.middleware" do |app|
         app.config.middleware.insert_before Warden::Manager, Decidim::CurrentOrganization
+        app.config.middleware.insert_before Warden::Manager, Decidim::StripXForwardedHost
         app.config.middleware.use BatchLoader::Middleware
       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)
+        app.config.assets.precompile += %w(decidim_core_manifest.js
+                                           decidim/identity_selector_dialog)
 
         Decidim.component_manifests.each do |component|
           app.config.assets.precompile += [component.icon]
@@ -98,23 +100,67 @@ module Decidim
         ActionView::Base.raise_on_missing_translations = true unless Rails.env.production?
       end
 
-      initializer "decidim.geocoding" do
-        if Decidim.geocoder.present?
-          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 => "..."
-          )
+      initializer "decidim.geocoding", after: :load_config_initializers do
+        Geocoder.configure(Decidim.geocoder) if Decidim.geocoder.present?
+      end
+
+      initializer "decidim.geocoding_extensions", after: "geocoder.insert_into_active_record" do
+        # Include it in ActiveRecord base in order to apply it to all models
+        # that may be using the `geocoded_by` or `reverse_geocoded_by` class
+        # methods injected by the Geocoder gem.
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:include, Decidim::Geocodable)
+        end
+      end
+
+      initializer "decidim.maps" do
+        Decidim::Map.register_category(:dynamic, Decidim::Map::Provider::DynamicMap)
+        Decidim::Map.register_category(:static, Decidim::Map::Provider::StaticMap)
+        Decidim::Map.register_category(:geocoding, Decidim::Map::Provider::Geocoding)
+        Decidim::Map.register_category(:autocomplete, Decidim::Map::Provider::Autocomplete)
+      end
+
+      # This keeps backwards compatibility with the old style of map
+      # configuration through Decidim.geocoder.
+      initializer "decidim.maps_legacysupport", after: :load_config_initializers do
+        next if Decidim.maps.present?
+        next if Decidim.geocoder.blank?
+
+        legacy_api_key ||= begin
+          if Decidim.geocoder[:here_api_key].present?
+            Decidim.geocoder.fetch(:here_api_key)
+          elsif Decidim.geocoder[:here_app_id].present?
+            [
+              Decidim.geocoder.fetch(:here_app_id),
+              Decidim.geocoder.fetch(:here_app_code)
+            ]
+          end
+        end
+        next unless legacy_api_key
+
+        ActiveSupport::Deprecation.warn(
+          <<~DEPRECATION.strip
+            Configuring maps functionality has changed.
+
+            Please update your current Decidim.geocoder configurations to the following format:
+
+              Decidim.configure do |config|
+                config.maps = {
+                  provider: :here,
+                  api_key: Rails.application.secrets.maps[:api_key],
+                  static: { url: "#{Decidim.geocoder.fetch(:static_map_url)}" }
+                }
+              end
+          DEPRECATION
+        )
+        Decidim.configure do |config|
+          config.maps = {
+            provider: :here,
+            api_key: legacy_api_key,
+            static: {
+              url: Decidim.geocoder.fetch(:static_map_url)
+            }
+          }
         end
       end
 
@@ -191,7 +237,7 @@ module Decidim
 
       initializer "decidim.content_processors" do |_app|
         Decidim.configure do |config|
-          config.content_processors += [:user, :hashtag, :link]
+          config.content_processors += [:user, :user_group, :hashtag, :link]
         end
       end
 
@@ -235,9 +281,7 @@ module Decidim
           # #call can be used in order to allow conditional checks (to allow non-SSL
           # redirects to localhost for example).
           #
-          # force_ssl_in_redirect_uri !Rails.env.development?
-          #
-          force_ssl_in_redirect_uri false
+          force_ssl_in_redirect_uri !Rails.env.development?
 
           # WWW-Authenticate Realm (default "Doorkeeper").
           realm "Decidim"
@@ -250,6 +294,22 @@ module Decidim
         end
       end
 
+      initializer "SSL and HSTS" do
+        Rails.application.configure do
+          config.force_ssl = Rails.env.production? && Decidim.config.force_ssl
+        end
+      end
+
+      initializer "Disable Rack::Runtime" do
+        Rails.application.configure do
+          config.middleware.delete Rack::Runtime
+        end
+      end
+
+      initializer "Expire sessions" do
+        Rails.application.config.session_store :cookie_store, expire_after: Decidim.config.expire_session_after
+      end
+
       initializer "decidim.core.register_resources" do
         Decidim.register_resource(:user) do |resource|
           resource.model_class_name = "Decidim::User"
@@ -297,7 +357,7 @@ module Decidim
         end
       end
 
-      initializer "decidim.core.content_blocks" do
+      initializer "decidim.core.homepage_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"
@@ -369,6 +429,68 @@ module Decidim
         end
       end
 
+      initializer "decidim.core.newsletter_templates" do
+        Decidim.content_blocks.register(:newsletter_template, :basic_only_text) do |content_block|
+          content_block.cell = "decidim/newsletter_templates/basic_only_text"
+          content_block.settings_form_cell = "decidim/newsletter_templates/basic_only_text_settings_form"
+          content_block.public_name_key = "decidim.newsletter_templates.basic_only_text.name"
+
+          content_block.settings do |settings|
+            settings.attribute(
+              :body,
+              type: :text,
+              translated: true,
+              preview: -> { I18n.t("decidim.newsletter_templates.basic_only_text.body_preview") }
+            )
+          end
+
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:newsletter_template, :image_text_cta) do |content_block|
+          content_block.cell = "decidim/newsletter_templates/image_text_cta"
+          content_block.settings_form_cell = "decidim/newsletter_templates/image_text_cta_settings_form"
+          content_block.public_name_key = "decidim.newsletter_templates.image_text_cta.name"
+
+          content_block.images = [
+            {
+              name: :main_image,
+              uploader: "Decidim::NewsletterTemplateImageUploader",
+              preview: -> { ActionController::Base.helpers.asset_path("decidim/placeholder.jpg") }
+            }
+          ]
+
+          content_block.settings do |settings|
+            settings.attribute(
+              :introduction,
+              type: :text,
+              translated: true,
+              preview: -> { I18n.t("decidim.newsletter_templates.image_text_cta.introduction_preview") }
+            )
+            settings.attribute(
+              :body,
+              type: :text,
+              translated: true,
+              preview: -> { I18n.t("decidim.newsletter_templates.image_text_cta.body_preview") }
+            )
+            settings.attribute(
+              :cta_text,
+              type: :text,
+              translated: true,
+              preview: -> { I18n.t("decidim.newsletter_templates.image_text_cta.cta_text_preview") }
+            )
+            settings.attribute(
+              :cta_url,
+              type: :text,
+              translated: true,
+              preview: -> { "http://decidim.org" }
+            )
+          end
+
+          content_block.default!
+        end
+      end
+
       initializer "decidim.core.add_badges" do
         Decidim::Gamification.register_badge(:invitations) do |badge|
           badge.levels = [1, 5, 10, 30, 50]
@@ -384,6 +506,10 @@ module Decidim
       initializer "nbspw" do
         NOBSPW.configuration.use_ruby_grep = true
       end
+
+      config.to_prepare do
+        FoundationRailsHelper::FlashHelper.send(:include, Decidim::FlashHelperExtensions)
+      end
     end
   end
 end

data/lib/decidim/core/test.rb

@@ -5,6 +5,7 @@ require "decidim/core/test/shared_examples/authorable"
 require "decidim/core/test/shared_examples/coauthorable"
 require "decidim/core/test/shared_examples/publicable"
 require "decidim/core/test/shared_examples/localised_email"
+require "decidim/core/test/shared_examples/logo_email"
 require "decidim/core/test/shared_examples/has_attachments"
 require "decidim/core/test/shared_examples/has_attachment_collections"
 require "decidim/core/test/shared_examples/has_component"
@@ -23,11 +24,13 @@ 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"
 require "decidim/core/test/shared_examples/component_type"
+require "decidim/core/test/shared_examples/scopable_resource_examples"
 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"
+require "decidim/core/test/shared_examples/endorsements_controller_shared_context"
 require "decidim/core/test/shared_examples/amendable/create_amendment_draft_examples"
 require "decidim/core/test/shared_examples/amendable/update_amendment_draft_examples"
 require "decidim/core/test/shared_examples/amendable/destroy_amendment_draft_examples"
@@ -46,3 +49,15 @@ require "decidim/core/test/shared_examples/uncommentable_component_examples"
 require "decidim/core/test/shared_examples/searchable_resources_shared_context"
 require "decidim/core/test/shared_examples/searchable_participatory_space_examples"
 require "decidim/core/test/shared_examples/has_private_users"
+require "decidim/core/test/shared_examples/with_endorsable_permissions_examples"
+require "decidim/core/test/shared_examples/system_endorse_resource_examples"
+require "decidim/core/test/shared_examples/rich_text_editor_examples"
+require "decidim/core/test/shared_examples/back_to_list_button_examples"
+require "decidim/core/test/shared_examples/permissions"
+require "decidim/core/test/shared_examples/admin_resource_gallery_examples"
+require "decidim/core/test/shared_examples/map_examples"
+require "decidim/core/test/shared_examples/preview_component_with_share_token_examples"
+require "decidim/core/test/shared_examples/manage_component_share_tokens"
+require "decidim/core/test/shared_examples/metric_manage_shared_context"
+require "decidim/core/test/shared_examples/embed_resource_examples"
+require "decidim/core/test/shared_examples/resource_search_examples"

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

@@ -13,7 +13,7 @@ end
 
 FactoryBot.define do
   sequence(:title) do |n|
-    "#{Faker::Lorem.sentence(3)} #{n}"
+    "#{Faker::Lorem.sentence(3)} #{n}".delete("'")
   end
 
   sequence(:name) do |n|
@@ -21,11 +21,11 @@ FactoryBot.define do
   end
 
   sequence(:nickname) do |n|
-    "#{Faker::Lorem.characters(rand(1..10))}_#{n}"
+    "#{Faker::Lorem.characters(rand(1..10))}_#{n}".gsub("'", "_")
   end
 
   sequence(:hashtag_name) do |n|
-    "#{Faker::Lorem.characters(rand(1..10))}_#{n}"
+    "#{Faker::Lorem.characters(rand(1..10))}_#{n}".gsub("'", "_")
   end
 
   sequence(:email) do |n|
@@ -37,7 +37,7 @@ FactoryBot.define do
   end
 
   sequence(:slug) do |n|
-    "#{Faker::Internet.slug(nil, "-")}-#{n}"
+    "#{Faker::Internet.slug(nil, "-")}-#{n}".gsub("'", "_")
   end
 
   sequence(:scope_name) do |n|
@@ -69,6 +69,7 @@ FactoryBot.define do
   factory :organization, class: "Decidim::Organization" do
     name { Faker::Company.unique.name }
     reference_prefix { Faker::Name.suffix }
+    time_zone { "UTC" }
     twitter_handler { Faker::Hipster.word }
     facebook_handler { Faker::Hipster.word }
     instagram_handler { Faker::Hipster.word }
@@ -88,7 +89,10 @@ FactoryBot.define do
     badges_enabled { true }
     user_groups_enabled { true }
     send_welcome_notification { true }
+    comments_max_length { 1000 }
+    admin_terms_of_use_body { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
     force_users_to_authenticate_before_access_organization { false }
+    machine_translation_display_priority { "original" }
     smtp_settings do
       {
         "from" => "test@example.org",
@@ -98,6 +102,7 @@ FactoryBot.define do
         "address" => "smtp.example.org"
       }
     end
+    file_upload_settings { Decidim::OrganizationSettings.default(:upload) }
 
     after(:create) do |organization|
       tos_page = Decidim::StaticPage.find_by(slug: "terms-and-conditions", organization: organization)
@@ -130,12 +135,18 @@ FactoryBot.define do
       deleted_at { Time.current }
     end
 
+    trait :admin_terms_accepted do
+      admin_terms_accepted_at { Time.current }
+    end
+
     trait :admin do
       admin { true }
+      admin_terms_accepted
     end
 
     trait :user_manager do
       roles { ["user_manager"] }
+      admin_terms_accepted
     end
 
     trait :managed do
@@ -173,9 +184,9 @@ FactoryBot.define do
     sequence(:name) { |n| "#{Faker::Company.name} #{n}" }
     email { generate(:user_group_email) }
     nickname { generate(:nickname) }
-    avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
     about { "<script>alert(\"ABOUT\");</script>" + Faker::Lorem.paragraph(2) }
     organization
+    avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") } # Keep after organization
 
     transient do
       users { [] }
@@ -250,7 +261,7 @@ FactoryBot.define do
     organization { build(:organization) }
 
     trait :default do
-      slug { (Decidim::StaticPage::DEFAULT_PAGES - ["terms-and-conditions"]).sample }
+      slug { Decidim::StaticPage::DEFAULT_PAGES.sample }
     end
 
     trait :tos do
@@ -287,10 +298,10 @@ FactoryBot.define do
   factory :attachment, class: "Decidim::Attachment" do
     title { generate_localized_title }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
-    file { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
     weight { Faker::Number.number(1) }
     attached_to { build(:participatory_process) }
     content_type { "image/jpeg" }
+    file { Decidim::Dev.test_file("city.jpeg", "image/jpeg") } # Keep after attached_to
     file_size { 108_908 }
 
     trait :with_image do
@@ -325,6 +336,15 @@ FactoryBot.define do
       }
     end
 
+    trait :with_one_step do
+      step_settings do
+        participatory_space_with_steps if participatory_space.active_step.nil?
+        {
+          participatory_space.active_step.id => { dummy_step_setting: true }
+        }
+      end
+    end
+
     trait :unpublished do
       published_at { nil }
     end
@@ -344,6 +364,44 @@ FactoryBot.define do
     trait :with_permissions do
       settings { { Random.rand => Random.new.bytes(5) } }
     end
+
+    transient do
+      participatory_space_with_steps do
+        create(:participatory_process_step,
+               active: true,
+               end_date: 1.month.from_now,
+               participatory_process: participatory_space)
+        participatory_space.reload
+        participatory_space.steps.reload
+      end
+    end
+
+    trait :with_endorsements_enabled do
+      step_settings do
+        participatory_space_with_steps if participatory_space.active_step.nil?
+        {
+          participatory_space.active_step.id => { endorsements_enabled: true }
+        }
+      end
+    end
+
+    trait :with_endorsements_disabled do
+      step_settings do
+        participatory_space_with_steps if participatory_space.active_step.nil?
+        {
+          participatory_space.active_step.id => { endorsements_enabled: false }
+        }
+      end
+    end
+
+    trait :with_endorsements_blocked do
+      step_settings do
+        participatory_space_with_steps if participatory_space.active_step.nil?
+        {
+          participatory_space.active_step.id => { endorsements_blocked: true }
+        }
+      end
+    end
   end
 
   factory :scope_type, class: "Decidim::ScopeType" do
@@ -387,7 +445,12 @@ FactoryBot.define do
   end
 
   factory :dummy_resource, class: "Decidim::DummyResources::DummyResource" do
-    title { generate(:name) }
+    transient do
+      users { nil }
+      # user_groups correspondence to users is by sorting order
+      user_groups { [] }
+    end
+    title { Decidim::Faker::Localized.localized { generate(:name) } }
     component { create(:component, manifest_name: "dummy") }
     author { create(:user, :confirmed, organization: component.organization) }
     scope { create(:scope, organization: component.organization) }
@@ -395,6 +458,38 @@ FactoryBot.define do
     trait :published do
       published_at { Time.current }
     end
+
+    trait :with_endorsements do
+      after :create do |resource|
+        5.times.collect do
+          create(:endorsement, resource: resource, author: build(:user, organization: resource.component.organization))
+        end
+      end
+    end
+  end
+
+  factory :nested_dummy_resource, class: "Decidim::DummyResources::NestedDummyResource" do
+    title { generate(:name) }
+    dummy_resource { create(:dummy_resource) }
+  end
+
+  factory :coauthorable_dummy_resource, class: "Decidim::DummyResources::CoauthorableDummyResource" do
+    title { generate(:name) }
+    component { create(:component, manifest_name: "dummy") }
+
+    transient do
+      authors_list { [create(:user, organization: component.organization)] }
+    end
+
+    after :build do |resource, evaluator|
+      evaluator.authors_list.each do |coauthor|
+        resource.coauthorships << if coauthor.is_a?(::Decidim::UserGroup)
+                                    build(:coauthorship, author: coauthor.users.first, user_group: coauthor, coauthorable: resource, organization: evaluator.component.organization)
+                                  else
+                                    build(:coauthorship, author: coauthor, coauthorable: resource, organization: evaluator.component.organization)
+                                  end
+      end
+    end
   end
 
   factory :resource_link, class: "Decidim::ResourceLink" do
@@ -404,12 +499,25 @@ FactoryBot.define do
   end
 
   factory :newsletter, class: "Decidim::Newsletter" do
+    transient do
+      body { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    end
+
     author { build(:user, :confirmed, organization: organization) }
     organization
 
     subject { generate_localized_title }
 
-    body { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    after(:create) do |newsletter, evaluator|
+      create(
+        :content_block,
+        :newsletter_template,
+        organization: evaluator.organization,
+        scoped_resource_id: newsletter.id,
+        manifest_name: "basic_only_text",
+        settings: evaluator.body.transform_keys { |key| "body_#{key}" }
+      )
+    end
 
     trait :sent do
       sent_at { Time.current }
@@ -531,10 +639,15 @@ FactoryBot.define do
 
   factory :content_block, class: "Decidim::ContentBlock" do
     organization
-    scope { :homepage }
+    scope_name { :homepage }
     manifest_name { :hero }
     weight { 1 }
     published_at { Time.current }
+
+    trait :newsletter_template do
+      scope_name { :newsletter_template }
+      manifest_name { :basic_only_text }
+    end
   end
 
   factory :hashtag, class: "Decidim::Hashtag" do
@@ -567,4 +680,33 @@ FactoryBot.define do
       state { "rejected" }
     end
   end
+
+  factory :endorsement, class: "Decidim::Endorsement" do
+    resource { build(:dummy_resource) }
+    author { resource.try(:creator_author) || resource.try(:author) || build(:user, organization: resource.organization) }
+  end
+
+  factory :user_group_endorsement, class: "Decidim::Endorsement" do
+    resource { build(:dummy_resource) }
+    author { build(:user, organization: resource.organization) }
+    user_group { create(:user_group, verified_at: Time.current, organization: resource.organization, users: [author]) }
+  end
+
+  factory :share_token, class: "Decidim::ShareToken" do
+    token_for { build(:component) }
+    user { build(:user, organization: token_for.organization) }
+
+    before(:create) do |object|
+      object.organization ||= object.token_for.organization
+    end
+
+    trait :expired do
+      expires_at { 1.day.ago }
+    end
+
+    trait :used do
+      times_used { 3 }
+      last_used_at { 1.hour.ago }
+    end
+  end
 end