RDMO 2.3.0 ⭐

[jochenklar]

This is the development branch for RDMO 2.3.0 🚧👷💥.

Changelog 📔

• Add new interview interface based on React and Redux (Modernize the RDMO frontend #518)
  • Text and Textarea widgets are now saved automatically
  • Select dropdown widgets are now always searchable
  • Show the unit of a question next to the answer field (show the unit of a question next to the answer field #499)
  • Tabs (e.g. Datasets) and single values can be reused in different projects.
  • An "Apply to all" button can be used to paste information into all the tabs.
  • Remove custom widgets feature (remove QUESTIONS_WIDGETS from settings)
  • Fix several issues regarding the interview (Range slider does not save value automatically on touch devices #501, Display attributes in interview, answers, etc. to admins, editors, reviewers #224, Interview, slow loading on proceed when a lot of conditional pages are skipped. #1191)
  • Display attributes in interview to admins, editors, reviewers (Display attributes in interview, answers, etc. to admins, editors, reviewers #224)
  • Improve accessibility (RDMO should follow common accessibility guidelines #514, Accessibility review #1199)
• Add the possibility to copy a project including all its values.
• Add the option to make a project "visible" to all users ( [enhancement] Templates for projects and data sets  #152).
  • Users interact with visible projects as if they would have the Guest role.
  • With the new review feature, this can be used for templates for projects and datasets.
  • Sites and groups can be used to restrict this behaviour.
  • This feature is enabled by default via the PROJECT_VISIBILITY setting
• Add a contact form modal to each question to contact support (Add contact fuctionality to display help and support contact information  #502)
  • PROJECT_CONTACT = True and PROJECT_CONTACT_RECIPIENTS = [list of email strings]
    enable this feature
• Add signal handlers to automatically sync of project views and tasks (Update available views when changing catalog of a project  #345, [DMP Review] Automatically activate new tasks for existing projects #966, "view" doesn't change when "catalog" is changed #1198)
  • When PROJECT_VIEWS_SYNC = True or PROJECT_TASKS_SYNC = True is set, the views or
    tasks for a project are automatically synchronized, depending on the
    catalogs configured for them.
• Add snapshot export plugins (which work like project export plugins)
  • Add PROJECT_SNAPSHOT_EXPORTS to settings to register snapshot export plugins
• Refactor the accept field for project import plugins
  • The field is now a dict of the form {'content_type': ['suffix']}
  • The old form should still work
• Add rdmo.accounts.middleware.TermsAndConditionsRedirectMiddleware' (No Terms of Use when using Shibboleth #141, Social login does not show Terms of Use #161)
  • The (optional) middleware checks if a user has already confirmed the Terms of use.
  • If not, users need to confirm to proceed.
  • Optionally, when a confirmation renewal is required, the ACCOUNT_TERMS_OF_USE_DATE = '2025-02-25'
    can be set to invalidate previous confirmations.
• Add rdmo-admin script
  • rdmo-admin npm run [build:prod|build|watch] can be used to build the front end
  • rdmo-admin build can be used to build the python package
  • rdmo-admin messages [make|compile] can be used create and compile the translations
  • rdmo-admin clean can be used remove most files which are not version controlled
• Add the support for custom markdown templates injected into help texts
  • The code {{ code }} is replaced by a template specified in the MARKDOWN_TEMPLATES setting
  • The `TEMPLATES_EXECUTE_SCRIPT_TAGS' setting controls whether Java script code can be executed.
• Add minimum required version to RDMO XML exports (Add minimum version to RDMO XML exports #1205).
• Use the uri instead of path for attributes in the Django admin interface.
• Fix a set of bugs where the maximum length of a field was not correctly validated by the API.
• Use lualatex when using Pandoc >= 3.0.
• Remove the download_vendor_files step of the setup
  • Remove VENDOR and VENDOR_CDN from settings.
• Remove django-rest-swagger dependency and add drf-spectacular as an optional dependency.
  • Can be installed with pip install rdmo[openapi].
• Update Python and JavaScript dependencies.
• Drop support for Python 3.8.

Breaking Changes ⚠️

• rdmo/accounts/adapter.py is renamed to account.py
  • rdmo/accounts/adapter.py → rdmo/accounts/account.py
• Updates to core/base.html and projects/project_detail_sidebar.html, see below.

Maintenance 🛠️

• webpack: added build:dist, fails on non-performance warnings (npm build warnings in CI #1197)

Important changes to templates 🔧

In RDMO 2.3.0, we made changes to the core/base.html template. If changed this file in you local theme you need to update it accordingly. At the top, the current language is set at an attribute to <html>:

{% load static compress core_tags i18n %}{% get_current_language as lang_code %}<!DOCTYPE html>
<html lang="{{ lang_code }}">

The {% block vendor %} needs to be removed.

The {% block css %} now looks like this:

    {% block css %}
    <link rel="stylesheet" href="{% static 'core/css/base.css' %}" />

    {% compress css %}
    <link rel="stylesheet" type="text/x-scss" href="{% static 'core/css/base.scss' %}" />
    <link rel="stylesheet" type="text/x-scss" href="{% static 'core/css/fonts.scss' %}" />
    <link rel="stylesheet" type="text/x-scss" href="{% static 'core/css/footer.scss' %}" />

    <link rel="stylesheet" type="text/x-scss" href="{% static 'core/css/style.scss' %}" />
    {% endcompress %}

    {% endblock %}

And the {% block js %} now looks like this:

    {% block js %}
    <script src="{% url 'javascript-catalog' %}"></script>
    <script src="{% static 'core/js/base.js' %}"></script>
    {% endblock %}

See https://github.com/rdmorganiser/rdmo/blob/2.3.0/rdmo/core/templates/core/base.html for the file in the 2.3.0 branch.

We also changed slightly changed the projects/project_detail_sidebar.html template. If changed this file in you local theme you need to update it and change the url name project_question to project_interview:

...
<ul class="list-unstyled">
    <li id="project-questions">
        <strong>
            {% if can_change_value %}
            <a href="{% url 'project_interview' project.pk %}">{% trans 'Answer questions' %}</a>
            {% else %}
            <a href="{% url 'project_interview' project.pk %}">{% trans 'View questions' %}</a>
            {% endif %}
        </strong>
    </li>
</ul>
...

[coveralls]

coverage: 90.534% (+0.06%) from 90.478%
when pulling 6d6279d on 2.3.0
into 1eadee5 on main.

[MyPyDavid]

so close now.. 😅

[jochenklar]

Always one more commit.

[MyPyDavid]

I'm still curious what the test coverage will be.. 🛸