Merge branch 'development' into fix-template-save

Author: benjaminfaure

CHANGELOG.md

@@ -7,8 +7,13 @@
 - Added popover for org profile page and added explanation for public plan
 ### Fixed
 
+- Froze mail gem version [#3254](https://github.com/DMPRoadmap/roadmap/issues/3254)
+- Updated the CSV export so that it now includes research outputs
+- Updated sans-serif font used in PDF downloads to Roboto since Google API no longer offers Helvetica
+- Fixed discrepencies with default/max per_page values for API and UI pagination
 - Updated JS that used to call the TinyMCE `setMode()` function so that it now calls `mode.set()` because the former is now deprecated.
 - Patched an issue that was causing a template's visibility to change to 'organizationally_visible' when saving on the template details page.
+- Fixed an issue with the Rails 6 keyword arguments change that was causing the `paginable_sort_link` to fail
 
 ### Changed
 

Gemfile

@@ -218,6 +218,11 @@ gem 'dotenv-rails'
 
 gem 'activerecord_json_validator'
 
+# We need to freeze the mail gem version as the recently released 2.8.0 triggers an exception
+# We will need to check if it's fixed when we migrate to Ruby 3.0/3.1
+# See : https://github.com/DMPRoadmap/roadmap/issues/3254
+gem 'mail', '2.7.1'
+
 # ================================= #
 # ENVIRONMENT SPECIFIC DEPENDENCIES #
 # ================================= #

Gemfile.lock

@@ -579,6 +579,7 @@ DEPENDENCIES
   kaminari
   ledermann-rails-settings
   listen
+  mail (= 2.7.1)
   mimemagic
   mocha
   mysql2
@@ -624,4 +625,4 @@ RUBY VERSION
    ruby 2.7.6p219
 
 BUNDLED WITH
-   2.3.25
+   2.3.26

app/controllers/api/v0/plans_controller.rb

@@ -98,7 +98,11 @@ def index
         plan_ids = extract_param_list(params, 'plan')
         @plans = @plans.where(id: plan_ids) if plan_ids.present?
         # apply pagination after filtering
-        @args = { per_page: params[:per_page], page: params[:page] }
+        max_per_page = Rails.configuration.x.application.api_max_page_size
+        page = params.fetch('page', 1).to_i
+        per_page = params.fetch('per_page', max_per_page).to_i
+        per_page = max_per_page if @per_page > max_per_page
+        @args = { per_page: per_page, page: page }
         @plans = refine_query(@plans)
         respond_with @plans
       end

app/controllers/api/v1/base_api_controller.rb

@@ -60,9 +60,10 @@ def base_response_content
       # Retrieve the requested pagination params or use defaults
       # only allow 100 per page as the max
       def pagination_params
+        max_per_page = Rails.configuration.x.application.api_max_page_size
         @page = params.fetch('page', 1).to_i
-        @per_page = params.fetch('per_page', 20).to_i
-        @per_page = 100 if @per_page > 100
+        @per_page = params.fetch('per_page', max_per_page).to_i
+        @per_page = max_per_page if @per_page > max_per_page
       end
 
       # Parse the body of the incoming request

app/controllers/concerns/paginable.rb

@@ -156,7 +156,7 @@ def refine_query(scope)
     if @args[:page] != 'ALL'
       # Can raise error if page is not a number
       scope = scope.page(@args[:page])
-                   .per(@args.fetch(:per_page, Rails.configuration.x.application.api_max_page_size))
+                   .per(@args.fetch(:per_page, Rails.configuration.x.results_per_page))
     end
     scope
   end
@@ -200,7 +200,7 @@ def sort_link_url(sort_field)
                                     end
     base_url = paginable_base_url(query_params[:page])
     sort_url = URI(base_url)
-    sort_url.query = stringify_query_params(query_params)
+    sort_url.query = stringify_query_params(**query_params)
     sort_url.to_s
     "#{sort_url}&#{stringify_nonpagination_query_params}"
   end

app/controllers/plan_exports_controller.rb

@@ -73,7 +73,8 @@ def show_csv
                            @show_unanswered,
                            @selected_phase,
                            @show_custom_sections,
-                           @show_coversheet),
+                           @show_coversheet,
+                           @show_research_outputs),
               filename: "#{file_name}.csv"
   end
 

app/helpers/exports_helper.rb

@@ -10,7 +10,7 @@ module ExportsHelper
   }.freeze
 
   def font_face
-    @formatting[:font_face].presence || 'Arial, Helvetica, Sans-Serif'
+    @formatting[:font_face].presence || 'Roboto, Arial, Sans-Serif'
   end
 
   def font_size

app/models/concerns/exportable_plan.rb

@@ -22,7 +22,8 @@ def as_csv(user,
              unanswered = true,
              selected_phase = nil,
              show_custom_sections = true,
-             show_coversheet = false)
+             show_coversheet = false,
+             show_research_outputs = false)
     hash = prepare(user, show_coversheet)
     CSV.generate do |csv|
       prepare_coversheet_for_csv(csv, headings, hash) if show_coversheet
@@ -50,6 +51,10 @@ def as_csv(user,
           end
         end
       end
+      csv << []
+      csv << []
+
+      prepare_research_outputs_for_csv(csv, headings, hash) if show_research_outputs
     end
   end
   # rubocop:enable Style/OptionalBooleanParameter
@@ -93,6 +98,9 @@ def prepare(user, coversheet = false)
     end
     hash[:phases] = phases
 
+    # include any research outputs
+    hash[:research_outputs] = prepare_research_outputs
+
     record_plan_export(user, :pdf)
 
     hash
@@ -138,6 +146,29 @@ def prepare_coversheet
   end
   # rubocop:enable Metrics/AbcSize
 
+  # rubocop:disable Metrics/AbcSize
+  def prepare_research_outputs
+    research_outputs.map do |research_output|
+      presenter = ResearchOutputPresenter.new(research_output: research_output)
+      size_hash = presenter.converted_file_size(size: research_output.byte_size)
+
+      {
+        title: research_output.title,
+        description: research_output.description,
+        type: presenter.display_type,
+        anticipated_release_date: presenter.display_release,
+        initial_access_level: presenter.display_access,
+        intended_repositories: presenter.display_repository&.join(', '),
+        anticipated_file_size: "#{size_hash[:size]} #{size_hash[:unit]&.upcase}",
+        initial_license: presenter.display_license,
+        metadata_standards: presenter.display_metadata_standard&.join(', '),
+        may_contain_sensitive_data: presenter.display_boolean(value: research_output.sensitive_data),
+        may_contain_pii: presenter.display_boolean(value: research_output.personal_data)
+      }
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+
   # rubocop:disable Metrics/AbcSize
   def prepare_coversheet_for_csv(csv, _headings, hash)
     csv << [_('Title: '), format(_('%{title}'), title: title)]
@@ -183,6 +214,21 @@ def prepare_coversheet_for_csv(csv, _headings, hash)
   end
   # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
+  # rubocop:disable Metrics/AbcSize
+  def prepare_research_outputs_for_csv(csv, _headings, hash)
+    return false unless hash[:research_outputs].present? && hash[:research_outputs].any?
+
+    csv << [_('Research Outputs: ')]
+    # Convert the hash keys to column headers
+    csv << hash[:research_outputs].first.keys.map { |key| key.to_s.capitalize.gsub('_', ' ') }
+    hash[:research_outputs].each do |research_output|
+      csv << research_output.values
+    end
+    csv << []
+    csv << []
+  end
+  # rubocop:enable Metrics/AbcSize
+
   # rubocop:disable Metrics/AbcSize, Metrics/BlockLength, Metrics/MethodLength
   # rubocop:disable Metrics/ParameterLists
   def show_section_for_csv(csv, phase, section, headings, unanswered, hash)

app/models/settings/template.rb

@@ -18,7 +18,7 @@ module Settings
   class Template < RailsSettings::SettingObject
     VALID_FONT_FACES = [
       '"Times New Roman", Times, Serif',
-      'Arial, Helvetica, Sans-Serif'
+      'Roboto, Arial, Sans-Serif'
     ].freeze
 
     VALID_FONT_SIZE_RANGE = (8..14).freeze