decidim-initiatives 0.29.1 → 0.30.0.rc1

data/lib/decidim/exporters/initiative_votes_pdf.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Exporters
+    # Inherits from abstract PDF exporter. This class is used to set
+    # the parameters used to create a PDF when exporting Survey Answers.
+    #
+    class InitiativeVotesPDF < PDF
+      def initialize(collection, initiative, serializer = Serializer)
+        @initiative = initiative
+        super(collection, serializer)
+      end
+
+      protected
+
+      attr_reader :initiative
+
+      def page_orientation
+        :landscape
+      end
+
+      def add_data!
+        composer.formatted_text([translated_attribute(initiative.title)], style: :initiative_title)
+
+        add_initiative_data
+        add_signature_data
+      end
+
+      def styles
+        {
+          initiative_title: { font: bold_font, text_align: :center, font_size: 12, margin: [0, 0, 10, 0] },
+          initiative_th: { font: bold_font, font_size: 10 },
+          initiative_td: { font:, font_size: 10 },
+          vote_th: { font: bold_font, font_size: 11 },
+          vote_td: { font:, font_size: 10 }
+        }
+      end
+
+      def add_initiative_data
+        data_header = [
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_id", scope: "decidim.admin"), style: :initiative_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_title", scope: "decidim.admin"), style: :initiative_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_start_date", scope: "decidim.admin"), style: :initiative_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_end_date", scope: "decidim.admin"), style: :initiative_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_signatures_count", scope: "decidim.admin"), style: :initiative_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.initiative_scope", scope: "decidim.admin"), style: :initiative_th)
+        ]
+
+        data_row = [
+          layout.text(initiative.reference, style: :initiative_td),
+          layout.text(translated_attribute(initiative.title), style: :initiative_td),
+          layout.text(I18n.l(initiative.signature_start_date, format: :long), style: :initiative_td),
+          layout.text(I18n.l(initiative.signature_end_date, format: :long), style: :initiative_td),
+          layout.text(collection.count.to_s, style: :initiative_td),
+          layout.text(scope(initiative), style: :initiative_td)
+        ]
+
+        column_widths = [-1, -1.75, -0.55, -0.55, -1, -1]
+
+        cells = [
+          [layout.table([data_header], column_widths:, cell_style: row_style)],
+          [layout.table([data_row], column_widths:, cell_style: row_style)]
+        ]
+        composer.table(cells, cell_style:)
+      end
+
+      def add_signature_data
+        cells = [[layout.table([header], column_widths: signature_column_widths, cell_style: row_style)]]
+
+        collection.map.with_index do |vote, index|
+          cells.push([layout.table(vote_row(vote, index), column_widths: signature_column_widths, cell_style: row_style)])
+        end
+
+        composer.table(cells, margin: [20, 0, 0, 0], cell_style:)
+      end
+
+      def signature_column_widths
+        if collect_user_extra_fields
+          [-0.5, -1, -0.75, -0.75, -0.75, -0.75, -0.75, -0.5, -0.75]
+        else
+          [-0.5, -1, -0.75, -0.75, -0.75]
+        end
+      end
+
+      def vote_row(model, index)
+        cell = [
+          layout.text((index + 1).to_s, style: :vote_td),
+          layout.text(model.author.nickname, style: :vote_td),
+          layout.text(I18n.l(model.created_at, format: "%Y-%m-%d %H:%M:%S %Z"), style: :vote_td),
+          layout.text(truncate(model.hash_id), style: :vote_td)
+        ]
+
+        if collect_user_extra_fields
+          metadata ||= model.encrypted_metadata ? encryptor.decrypt(model.encrypted_metadata) : {}
+
+          cell += [
+            layout.text(metadata[:name_and_surname].presence || "", style: :vote_td),
+            layout.text(metadata[:document_number].presence || "", style: :vote_td),
+            layout.text(metadata[:date_of_birth].presence || "", style: :vote_td),
+            layout.text(metadata[:postal_code].presence || "", style: :vote_td)
+          ]
+        end
+
+        cell += [
+          layout.text(truncate(model.timestamp.presence || ""), style: :vote_td)
+        ]
+        [cell]
+      end
+
+      def scope(model)
+        return I18n.t("decidim.initiatives.unavailable_scope") if model.scope.blank?
+
+        translated_attribute(model.scope.name)
+      end
+
+      def header
+        header = [
+          layout.text(I18n.t("models.initiatives_votes.fields.signature_count", scope: "decidim.admin"), style: :vote_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.nickname", scope: "decidim.admin"), style: :vote_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.date_and_time", scope: "decidim.admin"), style: :vote_th),
+          layout.text(I18n.t("models.initiatives_votes.fields.hash", scope: "decidim.admin"), style: :vote_th)
+        ]
+
+        if collect_user_extra_fields
+          header += [
+            layout.text(I18n.t("models.initiatives_votes.fields.name_and_surname", scope: "decidim.admin"), style: :vote_th),
+            layout.text(I18n.t("models.initiatives_votes.fields.document_number", scope: "decidim.admin"), style: :vote_th),
+            layout.text(I18n.t("models.initiatives_votes.fields.date_of_birth", scope: "decidim.admin"), style: :vote_th),
+            layout.text(I18n.t("models.initiatives_votes.fields.postal_code", scope: "decidim.admin"), style: :vote_th)
+          ]
+        end
+
+        header += [
+          layout.text(I18n.t("models.initiatives_votes.fields.timestamp", scope: "decidim.admin"), style: :vote_th)
+        ]
+        header
+      end
+
+      def collect_user_extra_fields = initiative.type.collect_user_extra_fields
+
+      def cell_style
+        lambda do |cell|
+          cell.style.margin = 0
+          cell.style.padding = 0
+          cell.style.border(width: 1)
+          cell.style.background_color = "cccccc" if cell.row.zero?
+        end
+      end
+
+      def encryptor
+        @encryptor ||= Decidim::Initiatives::DataEncryptor.new(secret: "personal user metadata")
+      end
+
+      def truncate(text, length = 50)
+        text.truncate(length)
+      end
+
+      def row_style
+        { margin: 0, padding: [10, 0, 10, 5], border: { width: 0 } }
+      end
+    end
+  end
+end

data/lib/decidim/initiatives/admin_engine.rb

@@ -15,75 +15,94 @@ module Decidim
       paths["lib/tasks"] = nil
 
       routes do
-        resources :initiatives_types, except: :show do
-          resource :permissions, controller: "initiatives_types_permissions"
-          resources :initiatives_type_scopes, except: [:index, :show]
-        end
-
-        resources :initiatives_settings, only: [:edit, :update], controller: "initiatives_settings"
-
-        resources :initiatives, only: [:index, :edit, :update], param: :slug do
-          member do
-            get :send_to_technical_validation
-            post :publish
-            delete :unpublish
-            delete :discard
-            get :export_votes
-            get :export_pdf_signatures
-            post :accept
-            delete :reject
+        constraints(->(request) { Decidim::Admin::OrganizationDashboardConstraint.new(request).matches? }) do
+          resources :initiatives_types, except: :show do
+            resource :permissions, controller: "initiatives_types_permissions"
+            resources :initiatives_type_scopes, except: [:index, :show]
           end
 
-          collection do
-            get :export
-          end
+          resources :initiatives_settings, only: [:edit, :update], controller: "initiatives_settings"
 
-          resources :attachments, controller: "initiative_attachments", except: [:show]
-
-          resources :committee_requests, only: [:index] do
+          resources :initiatives, only: [:index, :edit, :update], param: :slug do
             member do
-              get :approve
-              delete :revoke
+              get :send_to_technical_validation
+              post :publish
+              delete :unpublish
+              delete :discard
+              get :export_votes
+              get :export_pdf_signatures
+              post :accept
+              delete :reject
             end
-          end
 
-          resource :permissions, controller: "initiatives_permissions"
+            collection do
+              get :export
+            end
 
-          resource :answer, only: [:edit, :update]
-        end
+            resources :attachments, controller: "initiative_attachments", except: [:show]
 
-        scope "/initiatives/:initiative_slug" do
-          resources :components do
-            resource :permissions, controller: "component_permissions"
-            member do
-              put :publish
-              put :unpublish
-              get :share
+            resources :committee_requests, only: [:index] do
+              member do
+                get :approve
+                delete :revoke
+              end
             end
-            resources :exports, only: :create
+
+            resource :permissions, controller: "initiatives_permissions"
+
+            resource :answer, only: [:edit, :update]
           end
 
-          resources :moderations do
-            member do
-              put :unreport
-              put :hide
-              put :unhide
+          scope "/initiatives/:initiative_slug" do
+            resources :components do
+              collection do
+                put :reorder
+                get :manage_trash, to: "components#manage_trash"
+              end
+              resource :permissions, controller: "component_permissions"
+              member do
+                put :publish
+                put :unpublish
+                get :share
+                put :hide
+                patch :soft_delete
+                patch :restore
+              end
+              resources :component_share_tokens, except: [:show], path: "share_tokens", as: "share_tokens"
+              resources :exports, only: :create
             end
-            resources :reports, controller: "moderations/reports", only: [:index, :show]
+
+            resources :moderations do
+              member do
+                put :unreport
+                put :hide
+                put :unhide
+              end
+              patch :bulk_action, on: :collection
+              resources :reports, controller: "moderations/reports", only: [:index, :show]
+            end
+
+            resources :initiative_share_tokens, except: [:show], path: "share_tokens"
           end
-        end
 
-        scope "/initiatives/:initiative_slug/components/:component_id/manage" do
-          Decidim.component_manifests.each do |manifest|
-            next unless manifest.admin_engine
+          scope "/initiatives/:initiative_slug/components/:component_id/manage" do
+            Decidim.component_manifests.each do |manifest|
+              next unless manifest.admin_engine
 
-            constraints CurrentComponent.new(manifest) do
-              mount manifest.admin_engine, at: "/", as: "decidim_admin_initiative_#{manifest.name}"
+              constraints CurrentComponent.new(manifest) do
+                mount manifest.admin_engine, at: "/", as: "decidim_admin_initiative_#{manifest.name}"
+              end
             end
           end
         end
       end
 
+      initializer "decidim_initiatives_admin.mount_routes" do |_app|
+        Decidim::Core::Engine.routes do
+          mount Decidim::Initiatives::AdminEngine, at: "/admin", as: "decidim_admin_initiatives"
+        end
+      end
+
       initializer "decidim_initiatives_admin.menu" do
         Decidim::Initiatives::Menu.register_admin_menu_modules!
         Decidim::Initiatives::Menu.register_admin_initiatives_components_menu!

data/lib/decidim/initiatives/application_form_pdf.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require "hexapdf"
+
+module Decidim
+  module Initiatives
+    class ApplicationFormPDF
+      include Decidim::OrganizationHelper
+      def initialize(initiative)
+        @initiative = initiative
+      end
+
+      def render
+        composer.styles(**styles)
+
+        add_logo
+        add_organization_data_box
+        add_author_box
+        add_promoter_box
+
+        composer.new_page
+
+        add_initiative_metadata_box
+        add_attachments_box
+        add_signature_box
+        add_legal_box
+
+        composer.write_to_string
+      end
+
+      private
+
+      attr_reader :initiative
+
+      delegate :document, to: :composer
+      delegate :layout, to: :document
+
+      def page = document.pages.first
+
+      def page_width = page.box(:media).width
+
+      def page_height = page.box(:media).height
+
+      def styles
+        {
+          h1: { font: bold_font, text_align: :center, font_size: 16, margin: [10, 0, 10, 0] },
+          title: { font: bold_font, text_align: :center, font_size: 12, margin: [10, 0, 10, 0] },
+          text: { font: bold_font, text_align: :left, font_size: 12, margin: [0, 0, 10, 0] },
+          td: { font:, text_align: :left, font_size: 12, margin: [0, 0, 10, 0] }
+        }
+      end
+
+      def add_author_box
+        cells = [
+          [{ content: layout.text(I18n.t("author_title", scope: "decidim.initiatives.initiatives.print"), style: :title), col_span: 3 }],
+          [{ content: layout.text(I18n.t("id_number", scope: "decidim.initiatives.initiatives.print"), style: :td), col_span: 3, padding: [5, 5, 20, 5] }],
+          [{ content: layout.text(I18n.t("full_name", scope: "decidim.initiatives.initiatives.print"), style: :td), col_span: 3, padding: [5, 5, 20, 5] }],
+          [{ content: layout.text(I18n.t("address", scope: "decidim.initiatives.initiatives.print"), style: :td), col_span: 3, padding: [5, 5, 20, 5] }],
+          [
+            { content: layout.text(I18n.t("city", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] },
+            { content: layout.text(I18n.t("province", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] },
+            { content: layout.text(I18n.t("postal_code", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] }
+          ],
+          [
+            { content: layout.text(I18n.t("phone_number", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] },
+            { content: layout.text(I18n.t("email", scope: "decidim.initiatives.initiatives.print"), style: :td), col_span: 2, padding: [5, 5, 20, 5] }
+          ]
+        ]
+        composer.table(cells, cell_style: { border: { width: 1 } }, style: { margin: [10, 0] })
+      end
+
+      def add_signature_box
+        cells = [
+          layout.text(I18n.t("place_date", scope: "decidim.initiatives.initiatives.print"), style: :title),
+          layout.text(I18n.t("signature", scope: "decidim.initiatives.initiatives.print"), style: :title)
+        ]
+        composer.table([cells], cell_style: { border: { width: 0 } }, style: { margin: [10, 0] })
+      end
+
+      def add_attachments_box
+        cells = [
+          [{ content: layout.text(I18n.t("initiative.attachments", scope: "decidim.initiatives.initiatives.print"), style: :title), col_span: 10 }]
+        ]
+
+        6.times do
+          cols = [
+            { content: layout.text(""), padding: 15 },
+            { content: layout.text(""), padding: 15, col_span: 9 }
+          ]
+          cells.push(cols)
+        end
+
+        composer.table(cells, cell_style: { border: { width: 1 } }, style: { margin: [10, 0] })
+      end
+
+      def add_promoter_box
+        cells = [
+          [{ content: layout.text(I18n.t("members_header", scope: "decidim.initiatives.initiatives.print"), style: :title), col_span: 3 }],
+          [
+            { content: layout.text(I18n.t("full_name", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] },
+            { content: layout.text(I18n.t("id_number", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] },
+            { content: layout.text(I18n.t("address", scope: "decidim.initiatives.initiatives.print"), style: :td), padding: [5, 5, 20, 5] }
+          ]
+        ]
+
+        4.times do
+          cols = []
+          3.times do
+            cols.push({ content: layout.text(""), padding: 15 })
+          end
+          cells.push(cols)
+        end
+
+        composer.table(cells, cell_style: { border: { width: 1 } }, style: { margin: [10, 0] })
+      end
+
+      def add_legal_box
+        composer.text(I18n.t("legal_text", scope: "decidim.initiatives.initiatives.print"), style: {
+                        font:, font_size: 10, margin: [100, 0]
+                      })
+      end
+
+      def add_initiative_metadata_box
+        composer.text(I18n.t("initiative.type", scope: "decidim.initiatives.initiatives.print"), style: :text)
+        composer.text(translated_attribute(initiative.type.title), style: :td)
+        composer.text(I18n.t("initiative.title", scope: "decidim.initiatives.initiatives.print"), style: :text)
+        composer.text(translated_attribute(initiative.title), style: :td)
+        composer.text(I18n.t("initiative.description", scope: "decidim.initiatives.initiatives.print"), style: :text)
+        composer.text(translated_attribute(initiative.description), style: :td)
+      end
+
+      def add_organization_data_box
+        composer.text(organization_name(initiative.organization), style: :h1)
+        cells = [
+          layout.text(I18n.t("general_title", scope: "decidim.initiatives.initiatives.print"), style: :title)
+        ]
+        composer.table([cells], cell_style: { border: { width: 1 } })
+      end
+
+      def add_logo
+        return if initiative.organization.logo.blank?
+
+        attached_image = initiative.organization.attached_uploader(:logo).variant(:thumb)
+        logo = document.images.add(StringIO.new(attached_image.download))
+        height, width = compute_dimensions(attached_image, 160, 80)
+
+        cells = ["", layout.image(logo, width:, height:), ""]
+        composer.table([cells], cell_style: { border: { width: 0 } })
+      end
+
+      def compute_dimensions(attached_image, max_width, max_height)
+        metadata = attached_image.blob.metadata.with_indifferent_access
+        aspect_ratio = metadata[:width] / metadata[:height]
+
+        if metadata[:width] >= metadata[:height]
+          max_height = (max_height / aspect_ratio).round
+        else
+          max_width = (max_width / aspect_ratio).round
+        end
+
+        return max_height, max_width
+      end
+
+      def font
+        @font ||= load_font("source-sans-pro-v21-cyrillic_cyrillic-ext_greek_greek-ext_latin_latin-ext_vietnamese-regular.ttf")
+      end
+
+      def bold_font
+        @bold_font ||= load_font("source-sans-pro-v21-cyrillic_cyrillic-ext_greek_greek-ext_latin_latin-ext_vietnamese-700.ttf")
+      end
+
+      def load_font(path)
+        document.fonts.add(Decidim::Core::Engine.root.join("app/packs/fonts/decidim/").join(path))
+      end
+
+      def composer
+        @composer ||= ::HexaPDF::Composer.new
+      end
+    end
+  end
+end

data/lib/decidim/initiatives/engine.rb

@@ -86,6 +86,12 @@ module Decidim
         end
       end
 
+      initializer "decidim_initiatives.mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::Initiatives::Engine, at: "/", as: "decidim_initiatives"
+        end
+      end
+
       initializer "decidim_initiatives.register_icons" do
         Decidim.icons.register(name: "Decidim::Initiative", icon: "lightbulb-flash-line", description: "Initiative", category: "activity", engine: :initiatives)
         Decidim.icons.register(name: "apps-line", icon: "apps-line", category: "system", description: "", engine: :initiatives)

data/lib/decidim/initiatives/menu.rb

@@ -66,6 +66,7 @@ module Decidim
                           active: is_active_link?(manage_component_path(component)) ||
                                   is_active_link?(decidim_admin_initiatives.edit_component_path(current_participatory_space, component)) ||
                                   is_active_link?(decidim_admin_initiatives.edit_component_permissions_path(current_participatory_space, component)) ||
+                                  is_active_link?(decidim_admin_initiatives.component_share_tokens_path(current_participatory_space, component)) ||
                                   participatory_space_active_link?(component),
                           if: component.manifest.admin_engine # && user_role_config.component_is_accessible?(component.manifest_name)
           end
@@ -106,6 +107,13 @@ module Decidim
                         decidim_admin_initiatives.moderations_path(current_participatory_space),
                         icon_name: "flag-line",
                         if: allowed_to?(:read, :moderation)
+
+          menu.add_item :initiatives_share_tokens,
+                        I18n.t("menu.share_tokens", scope: "decidim.admin"),
+                        decidim_admin_initiatives.initiative_share_tokens_path(current_participatory_space),
+                        active: is_active_link?(decidim_admin_initiatives.initiative_share_tokens_path(current_participatory_space)),
+                        icon_name: "share-line",
+                        if: allowed_to?(:read, :share_tokens, current_participatory_space:)
         end
       end
 

data/lib/decidim/initiatives/participatory_space.rb

@@ -38,12 +38,19 @@ Decidim.register_participatory_space(:initiatives) do |participatory_space|
   participatory_space.model_class_name = "Decidim::Initiative"
   participatory_space.permissions_class_name = "Decidim::Initiatives::Permissions"
 
+  participatory_space.data_portable_entities = [
+    "Decidim::Initiative"
+  ]
+
   participatory_space.exports :initiatives do |export|
     export.collection do
-      Decidim::Initiative
+      Decidim::Initiative.public_spaces
     end
 
+    export.include_in_open_data = true
+
     export.serializer Decidim::Initiatives::InitiativeSerializer
+    export.open_data_serializer Decidim::Initiatives::OpenDataInitiativeSerializer
   end
 
   participatory_space.seeds do

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

@@ -108,6 +108,7 @@ FactoryBot.define do
     end
     type { create(:initiatives_type, skip_injection:) }
     scope { create(:scope, organization: type.organization, skip_injection:) }
+    taxonomy { create(:taxonomy, organization: type.organization, skip_injection:) }
     supports_required { 1000 }
 
     trait :with_user_extra_fields_collection do
@@ -124,8 +125,8 @@ FactoryBot.define do
     description { generate_localized_description(:initiative_description, skip_injection:) }
     organization
     author { create(:user, :confirmed, organization:, skip_injection:) }
-    published_at { Time.current }
-    state { "published" }
+    state { "open" }
+    published_at { Time.current.utc }
     signature_type { "online" }
     signature_start_date { Date.current - 1.day }
     signature_end_date { Date.current + 120.days }
@@ -156,12 +157,8 @@ FactoryBot.define do
       signature_end_date { nil }
     end
 
-    trait :published do
-      state { "published" }
-    end
-
-    trait :unpublished do
-      published_at { nil }
+    trait :open do
+      state { "open" }
     end
 
     trait :accepted do

data/lib/decidim/initiatives/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-initiatives version.
   module Initiatives
     def self.version
-      "0.29.1"
+      "0.30.0.rc1"
     end
   end
 end

data/lib/decidim/initiatives.rb

@@ -7,8 +7,14 @@ require "decidim/initiatives/admin_engine"
 require "decidim/initiatives/participatory_space"
 
 module Decidim
+  module Exporters
+    autoload :InitiativeVotesPDF, "decidim/exporters/initiative_votes_pdf"
+  end
+
   # Base module for the initiatives engine.
   module Initiatives
+    autoload :ApplicationFormPDF, "decidim/initiatives/application_form_pdf"
+
     include ActiveSupport::Configurable
 
     # Public setting that defines whether creation is allowed to any validated
@@ -32,7 +38,7 @@ module Decidim
 
     # Components enabled for a new initiative
     config_accessor :default_components do
-      [:pages, :meetings]
+      [:pages, :meetings, :blogs]
     end
 
     # Notifies when the given percentage of supports is reached for an