Conditional content (#355)

* add method - not used yet

* wip: rename fixture

for some reason having an underscore means the editor can not find it

* add contains to expression_item definitions

* Adding show options and defaults in schemas for conditional content

* Update schema for show

* update show key for content component to display to avoid conflict with definition.block

* update default metadata to display too

* Fixing conditional evaluator logic

* Adding a fixture for conditional content to fix some tests

* Remove the new conditional content feature and reference the good one

* Linting

* Make display schema key optional for backwards ccompatibility

* Add conditional api path to component dataset

* Call to evaluate content conditional from engine controller

* Handling of conditional content logic in the presenter view

* Handling several conditional component per page

* Handling display metadata to filter always or never display

* Renaming for clarity

* Removing unused method

* Fixing old conditional tests

* Fixing old engine controller tests

* Linting

* Adding tests for evaluate content conditional class

* Removing previous automated tests from previous implementation

* Adding correct test fixture

* Linting

* Adding some tests for evaluate content component

* dummy commit

* Adding tests for evaluate content conditional

* Getting all components by default as always

* Adding more tests and removing dummy commit

* Refactoring conditional component methods moved to page model

* Adding handling of AND rule for conditional content

* Adding handling for contains and does not contains

* Simplifying evaluate conditional content class

* Linting

* Refactoring conditional content evaluation in its class

* Making sure it is displayed if in editable mode and linting

* Update conditional.json text fixture

* Refactoring

* Updating tests for conditional content evaluator

* Updating logic to handle or rule - part 1 before refactoring

* Handling combinations of AND and OR rules

* Linting

* Checking all the answers

* Handling the case where we preview only one page and we show all conditional content but inform the user

* Using notification banner govuk design

* Updating notification message and using locales

* Showing the notification banner only once on the content page

* Refactor to move the logic in the page controller and create a single page preview page check

* Refactor and reduce lines by removing the HTML

* Conditional content deletion prevention additions (#354)

* Add content_expressions and content_conditionals methods to service

* Add conditional content fixture

* Fix page spec after merging

* Only show the notification banner in single page preview, not in the editor mode

* Show conditional content when preview a single page

* Adding conditional content notification banner for all content on single preview page

* Conditional content notification banner appears twice on cya so move this on all of pages

* Refactor conditional content banner into partial

* Notification banner should show only for show if and never conditional content

* Adjust page_with_component to use all components

* Show notification banner only when conditional content is present on the page

* Ensure legacy content components without display attribute get shown

* Add methods for returning pages that contain uuids used in conditional content expressions

* include extra components when detemrtining if there are content components present

* Don't show conditional notification in runner

* Fix display when in runner

* Update copy for conditional content notification banner

* Removing unused methods

* Add more service model unit tests

* Bumping up version prior release

---------

Co-authored-by: Natalie Seeto <[email protected]>
Co-authored-by: Chris Pymm <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -7,6 +7,11 @@ All notable changes to this project will be documented in this file.
 ### Changed
 ### Fixed
 
+## [3.2.11] - 2023-10-23
+### Changed
+- Updated the presenter logic for conditional content 
+- Added tests and tests fixtures for unit tests and editor acceptance tests
+
 ## [3.2.10] - 2023-08-24
 ### Fixed
 - Fixed an issue causing errors when resuming progress

app/controllers/metadata_presenter/engine_controller.rb

@@ -113,35 +113,6 @@ def external_or_relative_link(link)
     end
     helper_method :external_or_relative_link
 
-    def load_conditional_content
-      if @page.content_component_present?
-        if components_without_conditionals(@page).present?
-          return components_without_conditionals(@page) + show_components(@page).compact
-        end
-
-        show_components(@page).compact
-      end
-    end
-    helper_method :load_conditional_content
-
-    def components_without_conditionals(page)
-      page.content_components.select { |component|
-        component.conditionals.blank?
-      }.map(&:uuid)
-    end
-
-    def show_components(page)
-      return @page.content_components.map(&:uuid) if editor_preview?
-
-      page.content_components.map do |content_component|
-        EvaluateContentConditionals.new(
-          service:,
-          component: content_component,
-          user_data: load_user_data
-        ).show_component
-      end
-    end
-
     private
 
     def not_found
@@ -180,5 +151,18 @@ def show_maintenance_page
     def editor_preview?
       URI(request.original_url).path.split('/').include?('preview')
     end
+
+    def single_page_preview?
+      return false if in_runner?
+      return true if request.referrer.blank?
+
+      !URI(request.referrer).path.split('/').include?('preview')
+    end
+    helper_method :single_page_preview?
+
+    def in_runner?
+      ::Rails.application.class.module_parent.name == 'FbRunner'
+    end
+    helper_method :in_runner?
   end
 end

app/controllers/metadata_presenter/pages_controller.rb

@@ -8,7 +8,11 @@ def show
       @page ||= service.find_page_by_url(request.env['PATH_INFO'])
       if @page
         load_autocomplete_items
-        load_conditional_content
+        if single_page_preview?
+          @page.load_all_content
+        else
+          @page.load_conditional_content(service, @user_data)
+        end
 
         @page_answers = PageAnswers.new(@page, @user_data)
         render template: @page.template
@@ -35,6 +39,11 @@ def answered_pages
       TraversedPages.new(service, load_user_data, @page).all
     end
 
+    def conditional_components_present?
+      @page.conditional_components.any?
+    end
+    helper_method :conditional_components_present?
+
     private
 
     def set_caching_header

app/models/metadata_presenter/component.rb

@@ -88,6 +88,12 @@ def conditionals
     end
   end
 
+  def find_conditional_content_by_uuid(uuid)
+    metadata['conditionals'].select do |conditional|
+      conditional['_uuid'] == uuid
+    end
+  end
+
   private
 
   def validation_bundle_key

app/models/metadata_presenter/evaluate_content_conditionals.rb

@@ -1,35 +1,81 @@
 module MetadataPresenter
   class EvaluateContentConditionals
     include ActiveModel::Model
-    attr_accessor :service, :component, :user_data
+    attr_accessor :service, :user_data
 
-    def show_component
-      component_uuid
+    def evaluate_content_components(page)
+      displayed_components = []
+      page.content_components.map do |content_component|
+        next if page.conditionals_uuids_by_type('never').include?(content_component.uuid)
+
+        if page.conditionals_uuids_by_type('always').include?(content_component.uuid)
+          displayed_components << content_component.uuid
+        end
+        if page.conditionals_uuids_by_type('conditional').include?(content_component.uuid)
+          displayed_components << uuid_to_include?(content_component)
+        end
+      end
+      displayed_components.compact
     end
 
-    def component_uuid
-      @results ||=
-        conditionals.map do |conditional|
-          evaluated_expressions = conditional.expressions.map do |expression|
-            expression.service = service
-
-            Operator.new(
-              expression.operator
-            ).evaluate(
-              expression.field_label,
-              user_data[expression.expression_component.id]
-            )
-          end
+    private
 
-          if conditional.type == 'or' && evaluated_expressions.any?
-            component.uuid
-          elsif evaluated_expressions.all?
-            component.uuid
+    def uuid_to_include?(candidate_component)
+      evaluation_conditions = []
+      if candidate_component.conditionals.count == 1
+        # if there are only and rules or the particular case where there is only one condition
+        evaluation_conditions << evaluate_condition(candidate_component.conditionals[0])
+        return candidate_component.uuid if evaluation_conditions.flatten.all?
+      elsif candidate_component.conditionals.count > 1
+        # if there are or rule
+        if candidate_component.conditionals[0][:_type] == 'and'
+          # if there are 'and' in conditions between the 'or' rule
+          candidate_component.conditionals.map do |conditional|
+            evaluation_conditions << evaluate_condition(conditional).flatten.all?
           end
+          return candidate_component.uuid if evaluation_conditions.flatten.any?
         end
-      @results.flatten.compact.first
+        if candidate_component.conditionals[0][:_type] == 'if'
+          # then this is an 'or' condition between conditionals
+          candidate_component.conditionals.map do |conditional|
+            evaluation_conditions << evaluate_condition(conditional)
+          end
+          return candidate_component.uuid if evaluation_conditions.flatten.any?
+        end
+      end
     end
 
-    delegate :conditionals, to: :component
+    def evaluate_condition(conditional)
+      evaluation_expressions = []
+      conditional.expressions.map do |expression|
+        expression.service = service
+        case expression.operator
+        when 'is'
+          evaluation_expressions << check_answer_equal_expression(expression, user_data)
+        when 'is_not'
+          evaluation_expressions << !check_answer_equal_expression(expression, user_data)
+        when 'is_answered'
+          evaluation_expressions << user_data[expression.expression_component.id].present?
+        when 'is_not_answered'
+          evaluation_expressions << user_data[expression.expression_component.id].blank?
+        when 'contains'
+          evaluation_expressions << check_answer_include_expression(expression, user_data)
+        when 'does_not_contain'
+          evaluation_expressions << !check_answer_include_expression(expression, user_data)
+        end
+      end
+      evaluation_expressions
+    end
+
+    def check_answer_equal_expression(expression, user_data)
+      expression.field_label == user_data[expression.expression_component.id]
+    end
+
+    def check_answer_include_expression(expression, user_data)
+      answer = user_data[expression.expression_component.id]
+      return false if answer.blank?
+
+      answer.include?(expression.field_label)
+    end
   end
 end

app/models/metadata_presenter/page.rb

@@ -141,8 +141,37 @@ def placeholders
       end
     end
 
-    def content_component_present?
-      components.any?(&:content?)
+    def conditional_content_to_show
+      @conditional_content_to_show || []
+    end
+
+    def show_conditional_component?(component_id)
+      conditional_content_to_show.include?(component_id)
+    end
+
+    def load_conditional_content(service, user_data)
+      if content_component_present?
+        evaluator = EvaluateContentConditionals.new(service:, user_data:)
+        items = evaluator.evaluate_content_components(self)
+        items << legacy_content_components
+        assign_conditional_component(items.flatten)
+      end
+    end
+
+    def content_components_by_type(*display)
+      content_components.filter { |component| display.include? component[:display] }
+    end
+
+    def conditionals_uuids_by_type(*display)
+      content_components_by_type(*display).map { |component| component[:_uuid] }
+    end
+
+    def load_all_content
+      @conditional_content_to_show = content_components
+    end
+
+    def conditional_components
+      conditionals_uuids_by_type('never', 'conditional')
     end
 
     private
@@ -172,5 +201,17 @@ def supported_components(page_type)
     def raw_type
       type.gsub('page.', '')
     end
+
+    def assign_conditional_component(items)
+      @conditional_content_to_show = items
+    end
+
+    def content_component_present?
+      all_components.any?(&:content?)
+    end
+
+    def legacy_content_components
+      content_components.filter_map { |component| component[:_uuid] if component[:display].blank? }
+    end
   end
 end

app/models/metadata_presenter/service.rb

@@ -21,6 +21,14 @@ def conditionals
     branches.map(&:conditionals).flatten
   end
 
+  def content_expressions
+    content_conditionals.flat_map(&:expressions)
+  end
+
+  def content_conditionals
+    pages.flat_map(&:content_components).flat_map(&:conditionals)
+  end
+
   def flow_object(uuid)
     MetadataPresenter::Flow.new(uuid, metadata.flow[uuid])
   rescue StandardError
@@ -78,23 +86,32 @@ def no_back_link?(current_page)
 
   def page_with_component(uuid)
     pages.find do |page|
-      Array(page.components).any? { |component| component.uuid == uuid }
+      Array(page.all_components).any? { |component| component.uuid == uuid }
     end
   end
 
-  private
+  def pages_with_conditional_content_for_page(uuid)
+    pages.select do |page|
+      uuid.in? page.content_components_by_type('conditional').flat_map(&:conditionals).flat_map(&:expressions).map(&:page)
+    end
+  end
 
-  def all_pages
-    @all_pages ||= pages + standalone_pages
+  def pages_with_conditional_content_for_question(uuid)
+    pages.select do |page|
+      uuid.in?  page.content_components_by_type('conditional').flat_map(&:conditionals).flat_map(&:expressions).map(&:component)
+    end
   end
 
-  def flow_page(current_page)
-    page_index = pages.index(current_page)
-    pages[page_index - 1] if page_index.present?
+  def pages_with_conditional_content_for_question_option(uuid)
+    pages.select do |page|
+      uuid.in?  page.content_components_by_type('conditional').flat_map(&:conditionals).flat_map(&:expressions).map(&:field)
+    end
   end
 
-  def referrer_page(referrer)
-    find_page_by_url(URI(referrer).path) if referrer
+  private
+
+  def all_pages
+    @all_pages ||= pages + standalone_pages
   end
 
   def strip_slash(url)

app/views/metadata_presenter/component/_components.html.erb

@@ -1,12 +1,16 @@
 <% components.each_with_index do |component, index| %>
+
   <% if component.type == 'content' %>
+    <% next unless (editable? || @page.show_conditional_component?(component.uuid) || single_page_preview?) %>
+
     <editable-content id="<%= "page[#{component.collection}[#{index}]]" %>"
                       class="fb-editable govuk-!-margin-top-8"
                       type="<%= component.type %>"
                       default-content="<%= default_text('content') %>"
                       content="<%= component.content %>"
                       data-fb-content-id="<%= "page[#{component.collection}[#{index}]]" %>"
-                      data-config="<%= component.to_json %>">
+                      data-config="<%= component.to_json %>"
+                      data-conditional-api-path="<%= editable? ? URI.decode_www_form_component(api_service_edit_conditional_content_path(service.service_id, component.uuid)) : '' %>">
         <%= to_html(component.content) %>
     </editable-content>
   <% end %>

app/views/metadata_presenter/component/_conditional_component_banner.html.erb

@@ -0,0 +1,5 @@
+<% if single_page_preview? && !editable? && @page.conditional_components.any? %>
+  <%= govuk_notification_banner(title_text: 'Important') do |nb|
+    nb.with_heading(text: t('presenter.conditional_content.notification'))
+  end %>
+<% end%>

app/views/metadata_presenter/page/checkanswers.html.erb

@@ -2,6 +2,8 @@
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
 
+      <%= render partial:'metadata_presenter/component/conditional_component_banner'%>
+
       <h1 class="fb-editable govuk-heading-xl"
           data-fb-content-type="element"
           data-fb-content-id="page[heading]"
@@ -11,6 +13,7 @@
 
       <%= form_for @page, url: reserved_submissions_path, authenticity_token: false, html: { id: 'answers-form' } do |f| %>
         <%= hidden_field_tag :authenticity_token, form_authenticity_token -%>
+
         <%= render partial: 'metadata_presenter/component/components',
                    locals: {
                    f: f,