decidim-decidim_awesome 0.10.1 → 0.10.3

data/lib/decidim/decidim_awesome/engine.rb

@@ -4,6 +4,7 @@ require "rails"
 require "deface"
 require "decidim/core"
 require "decidim/decidim_awesome/awesome_helpers"
+require "decidim/decidim_awesome/menu"
 
 module Decidim
   module DecidimAwesome
@@ -26,46 +27,66 @@ module Decidim
           helper Decidim::LayoutHelper if respond_to?(:helper)
         end
         # Include additional helpers globally
-        ActionView::Base.include(Decidim::DecidimAwesome::AwesomeHelpers)
+        ActiveSupport.on_load(:action_view) { include Decidim::DecidimAwesome::AwesomeHelpers }
         # Also for cells
         Decidim::ViewModel.include(Decidim::DecidimAwesome::AwesomeHelpers)
 
         # Override EtiquetteValidator
-        EtiquetteValidator.include(Decidim::DecidimAwesome::EtiquetteValidatorOverride) if DecidimAwesome.enabled?([:validate_title_max_caps_percent,
-                                                                                                                    :validate_title_max_marks_together,
-                                                                                                                    :validate_title_start_with_caps,
-                                                                                                                    :validate_body_max_caps_percent,
-                                                                                                                    :validate_body_max_marks_together,
-                                                                                                                    :validate_body_start_with_caps])
+        EtiquetteValidator.include(Decidim::DecidimAwesome::EtiquetteValidatorOverride) if DecidimAwesome.enabled?(:validate_title_max_caps_percent,
+                                                                                                                   :validate_title_max_marks_together,
+                                                                                                                   :validate_title_start_with_caps,
+                                                                                                                   :validate_body_max_caps_percent,
+                                                                                                                   :validate_body_max_marks_together,
+                                                                                                                   :validate_body_start_with_caps)
 
         # Custom fields need to deal with several places
-        if DecidimAwesome.enabled?([:proposal_custom_fields,
-                                    :validate_title_min_length,
-                                    :validate_title_max_caps_percent,
-                                    :validate_title_max_marks_together,
-                                    :validate_title_start_with_caps,
-                                    :validate_body_min_length,
-                                    :validate_body_max_caps_percent,
-                                    :validate_body_max_marks_together,
-                                    :validate_body_start_with_caps])
+        if DecidimAwesome.enabled?(:proposal_custom_fields,
+                                   :proposal_private_custom_fields,
+                                   :validate_title_min_length,
+                                   :validate_title_max_caps_percent,
+                                   :validate_title_max_marks_together,
+                                   :validate_title_start_with_caps,
+                                   :validate_body_min_length,
+                                   :validate_body_max_caps_percent,
+                                   :validate_body_max_marks_together,
+                                   :validate_body_start_with_caps)
           Decidim::Proposals::ProposalWizardCreateStepForm.include(Decidim::DecidimAwesome::Proposals::ProposalWizardCreateStepFormOverride)
         end
 
-        # override user's admin property
-        Decidim::User.include(Decidim::DecidimAwesome::UserOverride) if DecidimAwesome.enabled?(:scoped_admins)
+        if DecidimAwesome.enabled?(:proposal_custom_fields, :proposal_private_custom_fields)
+          Decidim::Proposals::ProposalWizardCreateStepForm.include(Decidim::DecidimAwesome::Proposals::ProposalFormOverride)
+          Decidim::Proposals::Admin::ProposalForm.include(Decidim::DecidimAwesome::Proposals::ProposalFormOverride)
+          Decidim::Proposals::ProposalPresenter.include(Decidim::DecidimAwesome::Proposals::ProposalPresenterOverride)
+          Decidim::Proposals::CreateProposal.include(Decidim::DecidimAwesome::Proposals::CreateProposalOverride)
+          Decidim::Proposals::CreateCollaborativeDraft.include(Decidim::DecidimAwesome::Proposals::CreateCollaborativeDraftOverride)
+          Decidim::Proposals::Admin::CreateProposal.include(Decidim::DecidimAwesome::Proposals::CreateProposalOverride)
+          Decidim::Proposals::UpdateProposal.include(Decidim::DecidimAwesome::Proposals::UpdateProposalOverride)
+          Decidim::Proposals::UpdateCollaborativeDraft.include(Decidim::DecidimAwesome::Proposals::UpdateCollaborativeDraftOverride)
+          Decidim::Proposals::Admin::UpdateProposal.include(Decidim::DecidimAwesome::Proposals::Admin::UpdateProposalOverride)
+          Decidim::Proposals::ProposalType.include(Decidim::DecidimAwesome::AddProposalTypeCustomFields)
+        end
+
+        if DecidimAwesome.enabled?(:proposal_custom_fields, :proposal_private_custom_fields, :weighted_proposal_voting)
+          # add vote weight/private_body to proposals
+          Decidim::Proposals::Proposal.include(Decidim::DecidimAwesome::HasProposalExtraFields)
+          Decidim::Proposals::CollaborativeDraft.include(Decidim::DecidimAwesome::HasProposalExtraFields)
+        end
 
         if DecidimAwesome.enabled?(:weighted_proposal_voting)
           # add vote weight to proposal vote
           Decidim::Proposals::ProposalVote.include(Decidim::DecidimAwesome::HasVoteWeight)
-          # add vote weight cache to proposal
-          Decidim::Proposals::Proposal.include(Decidim::DecidimAwesome::HasProposalExtraFields)
-          Decidim::Proposals::ProposalSerializer.include(Decidim::DecidimAwesome::ProposalSerializerOverride)
-          Decidim::Proposals::ProposalType.include(Decidim::DecidimAwesome::ProposalTypeOverride)
+          Decidim::Proposals::ProposalType.include(Decidim::DecidimAwesome::AddProposalTypeVoteWeights)
           Decidim::Proposals::ProposalMCell.include(Decidim::DecidimAwesome::ProposalMCellOverride)
         end
 
-        Decidim::MenuPresenter.include(Decidim::DecidimAwesome::MenuPresenterOverride)
-        Decidim::MenuItemPresenter.include(Decidim::DecidimAwesome::MenuItemPresenterOverride)
+        # override user's admin property
+        Decidim::User.include(Decidim::DecidimAwesome::UserOverride) if DecidimAwesome.enabled?(:scoped_admins)
+
+        if DecidimAwesome.enabled?(:menu, :content_block_main_menu)
+          # Decidim::ContentBlocks::GlobalMenuCell.include(Decidim::DecidimAwesome::GlobalMenuCellOverride)
+          Decidim::MenuPresenter.include(Decidim::DecidimAwesome::MenuPresenterOverride)
+          Decidim::MenuItemPresenter.include(Decidim::DecidimAwesome::MenuItemPresenterOverride)
+        end
 
         # Late registering of components to take into account initializer values
         DecidimAwesome.registered_components.each do |manifest, block|
@@ -79,18 +100,24 @@ module Decidim
       initializer "decidim_decidim_awesome.overrides", after: "decidim.action_controller" do
         config.to_prepare do
           # redirect unauthorized scoped admins to allowed places or custom redirects if configured
-          Decidim::ErrorsController.include(Decidim::DecidimAwesome::NotFoundRedirect) if DecidimAwesome.enabled?([:scoped_admins, :custom_redirects])
+          Decidim::ErrorsController.include(Decidim::DecidimAwesome::NotFoundRedirect) if DecidimAwesome.enabled?(:scoped_admins, :custom_redirects)
 
           # Custom fields need to deal with several places
-          if DecidimAwesome.enabled?(:proposal_custom_fields)
+          if DecidimAwesome.enabled?(:proposal_custom_fields, :proposal_private_custom_fields)
             Decidim::Proposals::ApplicationHelper.include(Decidim::DecidimAwesome::Proposals::ApplicationHelperOverride)
             Decidim::AmendmentsHelper.include(Decidim::DecidimAwesome::AmendmentsHelperOverride)
           end
+          if DecidimAwesome.enabled?(:proposal_custom_fields, :proposal_private_custom_fields, :weighted_proposal_voting)
+            Decidim::Proposals::ProposalSerializer.include(Decidim::DecidimAwesome::Proposals::ProposalSerializerOverride)
+            Decidim::AdminLog::ComponentPresenter.include(Decidim::DecidimAwesome::AdminLog::ComponentPresenterOverride)
+          end
 
           if DecidimAwesome.enabled?(:weighted_proposal_voting)
             Decidim::Proposals::ProposalVotesController.include(Decidim::DecidimAwesome::Proposals::ProposalVotesControllerOverride)
           end
 
+          Decidim::AmendmentsController.include(Decidim::DecidimAwesome::LimitPendingAmendments) if DecidimAwesome.enabled?(:allow_limiting_amendments)
+
           Decidim::Proposals::ProposalsController.include(Decidim::DecidimAwesome::Proposals::OrderableOverride) if DecidimAwesome.enabled?(:additional_proposal_sortings)
         end
       end
@@ -99,14 +126,61 @@ module Decidim
         app.config.middleware.insert_after Decidim::Middleware::CurrentOrganization, Decidim::DecidimAwesome::CurrentConfig
       end
 
-      initializer "decidim_decidim_awesome.additional_proposal_sortings" do |_app|
-        if DecidimAwesome.enabled?(:additional_proposal_sortings)
-          Decidim.component_registry.find(:proposals).tap do |component|
-            component.settings(:global) do |settings|
-              settings.attribute :default_sort_order, type: :select, default: "default", choices: -> { ["default"] + DecidimAwesome.possible_additional_proposal_sortings }
+      initializer "decidim_decidim_awesome.additional_proposal_options" do |_app|
+        Decidim.component_registry.find(:proposals).tap do |component|
+          component.settings(:global) do |settings|
+            if DecidimAwesome.enabled?(:additional_proposal_sortings)
+              settings.attribute(
+                :default_sort_order,
+                type: :select,
+                default: "default",
+                choices: -> { (POSSIBLE_SORT_ORDERS + DecidimAwesome.possible_additional_proposal_sortings).uniq }
+              )
+            end
+            if DecidimAwesome.enabled?(:allow_limiting_amendments)
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :amendments_enabled,
+                :limit_pending_amendments,
+                Decidim::SettingsManifest::Attribute.new(type: :boolean, default: DecidimAwesome.allow_limiting_amendments)
+              )
             end
+          end
+
+          if DecidimAwesome.enabled?(:additional_proposal_sortings)
             component.settings(:step) do |settings|
-              settings.attribute :default_sort_order, type: :select, include_blank: true, choices: -> { ["default"] + DecidimAwesome.possible_additional_proposal_sortings }
+              settings.attribute(
+                :default_sort_order,
+                type: :select,
+                include_blank: true,
+                choices: -> { (POSSIBLE_SORT_ORDERS + DecidimAwesome.possible_additional_proposal_sortings).uniq }
+              )
+            end
+          end
+
+          if DecidimAwesome.enabled?(:proposal_private_custom_fields)
+            # Add to the "proposals" component an exporter that is not
+            # included in open-data to be able to export all private fields
+            # from the administration without exposing data to the frontend.
+            component.exports :awesome_private_proposals do |exports|
+              exports.collection do |component_instance, user|
+                space = component_instance.participatory_space
+
+                collection = Decidim::Proposals::Proposal
+                             .published
+                             .not_hidden
+                             .where(component: component_instance)
+                             .includes(:scope, :category, :component)
+
+                if space.user_roles(:valuator).where(user: user).any?
+                  collection.with_valuation_assigned_to(user, space)
+                else
+                  collection
+                end
+              end
+
+              exports.include_in_open_data = false
+              exports.serializer Decidim::DecidimAwesome::Proposals::PrivateProposalSerializer
             end
           end
         end
@@ -132,26 +206,43 @@ module Decidim
             next unless component
 
             component.settings(:global) do |settings|
-              settings.attribute :awesome_voting_manifest,
-                                 type: :select,
-                                 default: "",
-                                 choices: -> { ["default"] + Decidim::DecidimAwesome.voting_registry.manifests.map(&:name) },
-                                 readonly: lambda { |context|
-                                   Decidim::Proposals::Proposal.where(component: context[:component]).where.not(proposal_votes_count: 0).any?
-                                 }
-              settings.attribute :voting_cards_box_title,
-                                 type: :string,
-                                 translated: true
-              settings.attribute :voting_cards_show_modal_help,
-                                 type: :boolean,
-                                 default: true
-              settings.attribute :voting_cards_show_abstain,
-                                 type: :boolean,
-                                 default: false
-              settings.attribute :voting_cards_instructions,
-                                 type: :text,
-                                 translated: true,
-                                 editor: true
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :can_accumulate_supports_beyond_threshold,
+                :awesome_voting_manifest,
+                Decidim::SettingsManifest::Attribute.new(
+                  type: :select,
+                  default: "",
+                  choices: -> { ["default"] + Decidim::DecidimAwesome.voting_registry.manifests.map(&:name) },
+                  readonly: lambda { |context|
+                    Decidim::Proposals::Proposal.where(component: context[:component]).where.not(proposal_votes_count: -Float::INFINITY..0).any?
+                  }
+                )
+              )
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :awesome_voting_manifest,
+                :voting_cards_box_title,
+                Decidim::SettingsManifest::Attribute.new(type: :string, translated: true)
+              )
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :voting_cards_box_title,
+                :voting_cards_show_modal_help,
+                Decidim::SettingsManifest::Attribute.new(type: :boolean, default: true)
+              )
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :voting_cards_show_modal_help,
+                :voting_cards_show_abstain,
+                Decidim::SettingsManifest::Attribute.new(type: :boolean, default: false)
+              )
+              DecidimAwesome.hash_append!(
+                settings.attributes,
+                :voting_cards_show_abstain,
+                :voting_cards_instructions,
+                Decidim::SettingsManifest::Attribute.new(type: :text, translated: true, editor: true)
+              )
             end
           end
         end

data/lib/decidim/decidim_awesome/lock.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    class Lock
+      def initialize(organization, lock_time: DecidimAwesome.lock_time)
+        @organization = organization
+        @lock_time = lock_time
+      end
+
+      attr_reader :resource, :organization, :lock_time
+
+      def get!(resource)
+        @resource = resource
+        if config
+          config.update!(updated_at: Time.current)
+        else
+          AwesomeConfig.create!(var: var, organization: organization)
+        end
+      end
+
+      def release!(resource)
+        @resource = resource
+        config.destroy! if config
+      end
+
+      def locked?(resource)
+        @resource = resource
+        return false unless config
+        return true if config.reload.updated_at > lock_time.ago
+
+        config.destroy!
+        false
+      end
+
+      def config
+        AwesomeConfig.find_by(var: var, organization: organization)
+      end
+
+      private
+
+      def var
+        "lock-#{resource.class.name.underscore}_#{resource.id}"
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/menu.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    class Menu
+      class << self
+        def register_awesome_admin_menu!
+          Decidim.menu :awesome_admin_menu do |menu|
+            menu.add_item :editors,
+                          I18n.t("menu.editors", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:editors),
+                          position: 1,
+                          icon_name: "text",
+                          if: menus[:editors]
+
+            menu.add_item :proposals,
+                          I18n.t("menu.proposals", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:proposals),
+                          position: 2,
+                          icon_name: "document",
+                          if: menus[:proposals]
+
+            menu.add_item :surveys,
+                          I18n.t("menu.surveys", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:surveys),
+                          position: 3,
+                          icon_name: "spreadsheet",
+                          if: menus[:surveys]
+
+            menu.add_item :styles,
+                          I18n.t("menu.styles", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:styles),
+                          position: 4,
+                          icon_name: "brush",
+                          if: menus[:styles]
+
+            menu.add_item :proposal_custom_fields,
+                          I18n.t("menu.proposal_custom_fields", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:proposal_custom_fields),
+                          position: 5,
+                          icon_name: "layers",
+                          if: menus[:proposal_custom_fields],
+                          submenu: { target_menu: :custom_fields_submenu }
+
+            menu.add_item :admins,
+                          I18n.t("menu.admins", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:admins),
+                          position: 6,
+                          icon_name: "people",
+                          if: menus[:admins]
+
+            menu.add_item :menu_hacks,
+                          I18n.t("menu.menu_hacks", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.menu_hacks_path,
+                          position: 7,
+                          icon_name: "menu",
+                          if: menus[:menu_hacks]
+
+            menu.add_item :custom_redirects,
+                          I18n.t("menu.custom_redirects", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.custom_redirects_path,
+                          position: 8,
+                          icon_name: "share-boxed",
+                          if: menus[:custom_redirects]
+
+            menu.add_item :livechat,
+                          I18n.t("menu.livechat", scope: "decidim.decidim_awesome.admin"),
+                          decidim_admin_decidim_awesome.config_path(:livechat),
+                          position: 9,
+                          icon_name: "chat",
+                          if: menus[:livechat]
+
+            menu.add_item :maintenance,
+                          I18n.t("maintenance", scope: "decidim.decidim_awesome.admin.menu.maintenance"),
+                          decidim_admin_decidim_awesome.maintenance_path(:private_data),
+                          position: 10,
+                          icon_name: "pulse",
+                          submenu: { target_menu: :maintenance_submenu }
+          end
+        end
+
+        def register_custom_fields_submenu!
+          Decidim.menu :custom_fields_submenu do |menu|
+            menu.add_item :proposal_custom_fields,
+                          I18n.t("menu.title", scope: "decidim.decidim_awesome.admin.proposal_custom_fields"),
+                          decidim_admin_decidim_awesome.config_path(:proposal_custom_fields),
+                          position: 5.1,
+                          icon_name: "lock-unlocked",
+                          if: menus[:proposal_custom_fields]
+
+            menu.add_item :proposal_private_custom_fields,
+                          I18n.t("proposal_private_custom_fields", scope: "decidim.decidim_awesome.admin.proposal_custom_fields"),
+                          decidim_admin_decidim_awesome.config_path(:proposal_private_custom_fields),
+                          position: 5.2,
+                          icon_name: "lock-locked",
+                          if: menus[:proposal_private_custom_fields]
+          end
+        end
+
+        def register_maintenance_admin_menu!
+          Decidim.menu :maintenance_submenu do |menu|
+            menu.add_item :private_data,
+                          I18n.t("private_data", scope: "decidim.decidim_awesome.admin.menu.maintenance"),
+                          decidim_admin_decidim_awesome.maintenance_path(:private_data),
+                          position: 10,
+                          icon_name: "lock-locked"
+
+            menu.add_item :checks,
+                          I18n.t("checks", scope: "decidim.decidim_awesome.admin.menu.maintenance"),
+                          decidim_admin_decidim_awesome.checks_maintenance_index_path,
+                          position: 10,
+                          icon_name: "pulse"
+          end
+        end
+
+        def menus
+          @menus ||= {
+            editors: config_enabled?(:allow_images_in_full_editor, :allow_images_in_small_editor, :allow_videos_in_editors),
+            proposals: config_enabled?(
+              :allow_images_in_proposals,
+              :validate_title_min_length, :validate_title_max_caps_percent,
+              :validate_title_max_marks_together, :validate_title_start_with_caps,
+              :validate_body_min_length, :validate_body_max_caps_percent,
+              :validate_body_max_marks_together, :validate_body_start_with_caps
+            ),
+            surveys: config_enabled?(:auto_save_forms),
+            styles: config_enabled?(:scoped_styles),
+            proposal_custom_fields: config_enabled?(:proposal_custom_fields),
+            proposal_private_custom_fields: config_enabled?(:proposal_private_custom_fields),
+            admins: config_enabled?(:scoped_admins),
+            menu_hacks: config_enabled?(:menu, :home_content_block_menu),
+            menu_hacks_menu: config_enabled?(:menu),
+            menu_hacks_home_content_block_menu: config_enabled?(:home_content_block_menu),
+            custom_redirects: config_enabled?(:custom_redirects),
+            livechat: config_enabled?(:intergram_for_admins, :intergram_for_public)
+          }
+        end
+
+        # ensure boolean value
+        def config_enabled?(*vars)
+          DecidimAwesome.enabled?(*vars)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/test/initializer.rb

@@ -13,6 +13,7 @@ Decidim::DecidimAwesome.configure do |config|
       :intergram_for_public,
       :scoped_styles,
       :proposal_custom_fields,
+      :proposal_private_custom_fields,
       :menu,
       :scoped_admins,
       :custom_redirects,
@@ -25,7 +26,9 @@ Decidim::DecidimAwesome.configure do |config|
       :validate_body_max_marks_together,
       :validate_body_start_with_caps,
       :weighted_proposal_voting,
-      :additional_proposal_scopes
+      :additional_proposal_sortings,
+      :allow_limiting_amendments,
+      :proposal_private_custom_fields
     ].each do |conf|
       config.send("#{conf}=", :disabled)
     end

data/lib/decidim/decidim_awesome/test/shared_examples/{box_label_editor.rb → box_label_editor_examples.rb}

@@ -92,7 +92,7 @@ shared_examples "edits box label inline" do |test_case, key|
 
     case test_case
     when :css
-      sleep 1
+      sleep 2
       page.execute_script('document.querySelector("[data-key=a_new_label] .CodeMirror").CodeMirror.setValue("body {background: lilac;}");')
       find("*[type=submit]").click
       expect(page).to have_admin_callout("updated successfully")

data/lib/decidim/decidim_awesome/test/shared_examples/config_examples.rb

@@ -27,7 +27,8 @@ shared_examples "do not have menu link" do |item|
   end
 end
 
-shared_examples "forbids disabled feature" do
+shared_examples "forbids disabled feature without redirect" do
+  render_views
   let(:feature) { :menu }
   let(:features) { [feature] }
   before do
@@ -36,7 +37,24 @@ shared_examples "forbids disabled feature" do
     end
   end
 
-  it "redirects with error" do
+  it "fails with error" do
+    action
+
+    expect(response.body).to eq("no permissions for #{feature}")
+  end
+end
+
+shared_examples "forbids disabled feature with redirect" do
+  render_views
+  let(:feature) { :menu }
+  let(:features) { [feature] }
+  before do
+    features.each do |feat|
+      allow(Decidim::DecidimAwesome.config).to receive(feat).and_return(:disabled)
+    end
+  end
+
+  it "fails with error" do
     action
 
     expect(flash[:alert]).not_to be_empty