metadata_presenter 1.8.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd8a230778f6c6613c3929450b98894e27119904bd6c48829f008762b84b625
-  data.tar.gz: e8aecfc6eff1d694b09a44ba753e4777dce8c2f42d4f7de6922d9c2d82dd0aa9
+  metadata.gz: 4e13fd4a4a17bf97e91a2e69b59a5c12c3743e0cf38ce40a1c06b9b4b9915898
+  data.tar.gz: c35ff1dc9a73b802e01f4995a4224ac73077f1a2e00676e67e7a49095d29c6fb
 SHA512:
-  metadata.gz: 0fd423f52af55ecc54ff5c59e7c0f2c3a5032b129b51146bfe71f3f9a4e1ed8440984c3b5914fd87297b5c00d1cc71645d618ca49a277f57b05cb4da2f5f4daa
-  data.tar.gz: be951f7baf2331c9e42bdd5f9fbfd1a3adaeb5f3641a2acfb3aab00eb09b77fa5b78908a00f984da8781c6b9fe2997cfa6ef486c5c5bf4c22cb0b79f27259c8d
+  metadata.gz: 9d456b26ddc24e8e39e586eec91f7bc4acfd2c67506bc59d70fc1fdda8e8e0846dfc27fb965b9cd67653d6cca60ef7262a691cc4e8399486db0626b157f9b789
+  data.tar.gz: 073523ef858cf90830133c5c8f2cdc3a230b6d79c8b9794c2d156892cfbfbc8a8208f744937aa63f55cefa70d5846a533f4fa492dfbee35b8f2fa06122adbf46

data/app/models/metadata_presenter/component.rb

@@ -13,6 +13,12 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
     end
   end
 
+  SUPPORTS_BRANCHING = %w[radios checkboxes].freeze
+
+  def supports_branching?
+    type.in?(SUPPORTS_BRANCHING)
+  end
+
   def content?
     type == 'content'
   end

data/app/models/metadata_presenter/conditional.rb

@@ -0,0 +1,13 @@
+module MetadataPresenter
+  class Conditional < MetadataPresenter::Metadata
+    def ==(other)
+      metadata.to_h.deep_symbolize_keys == other.metadata.to_h.deep_symbolize_keys
+    end
+
+    def expressions
+      Array(metadata.expressions).map do |expression|
+        MetadataPresenter::Expression.new(expression)
+      end
+    end
+  end
+end

data/app/models/metadata_presenter/evaluate_conditionals.rb

@@ -0,0 +1,37 @@
+module MetadataPresenter
+  class EvaluateConditionals
+    include ActiveModel::Model
+    attr_accessor :service, :flow, :user_data
+
+    def page
+      evaluated_page_uuid = page_uuid || flow.default_next
+
+      service.find_page_by_uuid(evaluated_page_uuid)
+    end
+
+    def page_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
+
+        if conditional.type == 'or' && evaluated_expressions.any?
+          conditional.next
+        elsif evaluated_expressions.all?
+          conditional.next
+        end
+      end
+
+      @results.flatten.compact.first
+    end
+
+    delegate :conditionals, to: :flow
+  end
+end

data/app/models/metadata_presenter/expression.rb

@@ -0,0 +1,25 @@
+module MetadataPresenter
+  class Expression < MetadataPresenter::Metadata
+    attr_accessor :service
+
+    def ==(other)
+      metadata == other.metadata
+    end
+
+    def expression_page
+      service.find_page_by_uuid(page)
+    end
+
+    def expression_component
+      expression_page.find_component_by_uuid(component)
+    end
+
+    def expression_field
+      expression_component.find_item_by_uuid(field)
+    end
+
+    def field_label
+      expression_field['label'] if expression_field
+    end
+  end
+end

data/app/models/metadata_presenter/flow.rb

@@ -8,14 +8,14 @@ module MetadataPresenter
       metadata['next']['default']
     end
 
-    def conditions
-      Array(metadata['next']['conditions']).map do |condition_metadata|
-        Condition.new(condition_metadata)
+    def conditionals
+      Array(metadata['next']['conditionals']).map do |conditional_metadata|
+        Conditional.new(conditional_metadata)
       end
     end
 
     def group_by_page
-      conditions.group_by(&:next)
+      conditionals.group_by(&:next)
     end
   end
 end

data/app/models/metadata_presenter/next_page.rb

@@ -6,12 +6,10 @@ module MetadataPresenter
     def find
       return check_answers_page if return_to_check_your_answer?
 
-      if conditions?
-        evaluate_conditions
-      elsif current_page_flow.present?
-        service.find_page_by_uuid(current_page_flow.default_next)
+      if conditionals?
+        evaluate_conditionals
       else
-        service.next_page(from: current_page_url)
+        service.find_page_by_uuid(current_page_flow.default_next)
       end
     end
 
@@ -26,14 +24,14 @@ module MetadataPresenter
       session[:return_to_check_your_answer].present?
     end
 
-    def conditions?
+    def conditionals?
       current_page_flow.present? &&
         next_flow.present? &&
         next_flow_branch_object?
     end
 
-    def evaluate_conditions
-      EvaluateConditions.new(
+    def evaluate_conditionals
+      EvaluateConditionals.new(
         service: service,
         flow: next_flow,
         user_data: user_data

data/app/models/metadata_presenter/page.rb

@@ -65,8 +65,19 @@ module MetadataPresenter
       type == 'page.standalone'
     end
 
+    def title
+      return heading if heading?
+
+      components.first.humanised_title
+    end
+
     private
 
+    def heading?
+      Array(components).size != 1 ||
+        type.in?(['page.content', 'page.checkanswers', 'page.confirmation'])
+    end
+
     def to_components(node_components, collection:)
       node_components&.map do |component|
         MetadataPresenter::Component.new(

data/app/models/metadata_presenter/previous_page.rb

@@ -4,16 +4,11 @@ module MetadataPresenter
     attr_accessor :service, :user_data, :current_page, :referrer
 
     def page
-      # what happens when a user enters in the middle of the flow
       return if no_current_or_referrer_pages? || service.no_back_link?(current_page)
 
-      if service.flow.present?
-        return referrer_page if return_to_referrer?
+      return referrer_page if return_to_referrer?
 
-        TraversedPages.new(service, user_data, current_page).last
-      else
-        service.previous_page(current_page: current_page, referrer: referrer)
-      end
+      TraversedPages.new(service, user_data, current_page).last
     end
 
     private
@@ -23,6 +18,8 @@ module MetadataPresenter
     end
 
     def return_to_referrer?
+      return false unless current_page.standalone?
+
       current_page.standalone? ||
         (referrer_page && referrer_page.standalone?)
     end

data/app/models/metadata_presenter/traversed_pages.rb

@@ -2,18 +2,16 @@ module MetadataPresenter
   class TraversedPages
     attr_reader :service, :user_data, :current_page
 
-    def initialize(service, user_data, current_page)
+    def initialize(service, user_data, current_page = nil)
       @service = service
       @user_data = user_data
       @pages = [service.start_page]
-      @current_page = current_page
+      @current_page = current_page || service.pages[-1]
     end
 
     delegate :last, to: :all
 
     def all
-      return latest_pages if service.flow.blank?
-
       page_uuid = service.start_page.uuid
 
       service.flow.size.times do
@@ -22,7 +20,7 @@ module MetadataPresenter
         flow_object = service.flow_object(page_uuid)
 
         if flow_object.branch?
-          page = EvaluateConditions.new(
+          page = EvaluateConditionals.new(
             service: service,
             flow: flow_object,
             user_data: user_data

data/default_metadata/flow/branch.json

@@ -2,6 +2,6 @@
   "_type": "flow.branch",
   "next": {
     "default": "",
-    "conditions": []
+    "conditionals": []
   }
 }

data/default_metadata/flow/conditional.json

@@ -0,0 +1,5 @@
+{
+  "_type": "",
+  "next": "",
+  "expressions": []
+}

data/fixtures/branching.json

@@ -24,11 +24,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "0b297048-aa4d-49b6-ac74-18e069118185",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "e8708909-922e-4eaf-87a5-096f7a713fcb",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "68fbb180-9a2a-48f6-9da6-545e28b8d35a",
@@ -56,11 +56,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "05c3306c-0a39-42d2-9e0f-93fd49248f4e",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "d4342dfd-0d09-4a91-a0ea-d7fd67e706cc",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "0b297048-aa4d-49b6-ac74-18e069118185",
@@ -70,9 +70,9 @@
             ]
           },
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "91e9f7c6-2f75-4b7d-9eb5-0cf352f7be66",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "0b297048-aa4d-49b6-ac74-18e069118185",
@@ -106,11 +106,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "ef2cafe3-37e2-4533-9b0c-09a970cd38d4",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "8002df6e-29ab-4cdf-b520-1d7bb931a28f",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is_answered",
                 "page": "05c3306c-0a39-42d2-9e0f-93fd49248f4e",
@@ -138,11 +138,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "b5efc09c-ece7-45ae-b0b3-8a7905e25040",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is_not",
                 "page": "ef2cafe3-37e2-4533-9b0c-09a970cd38d4",
@@ -170,11 +170,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "bc666714-c0a2-4674-afe5-faff2e20d847",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
@@ -184,9 +184,9 @@
             ]
           },
           {
-            "condition_type": "if",
+            "_type": "if",
             "next": "e2887f44-5e8d-4dc0-b1de-496ab6039430",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is_not",
                 "page": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
@@ -220,11 +220,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "48357db5-7c06-4e85-94b1-5e1c9d8f39eb",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "or",
+            "_type": "or",
             "next": "2cc66e51-2c14-4023-86bf-ded49887cdb2",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
@@ -240,9 +240,9 @@
             ]
           },
           {
-            "condition_type": "and",
+            "_type": "and",
             "next": "f6c51f88-7be8-4cb7-bbfc-6c905727a051",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "68fbb180-9a2a-48f6-9da6-545e28b8d35a",
@@ -282,11 +282,11 @@
       "_type": "flow.branch",
       "next": {
         "default": "941137d7-a1da-43fd-994a-98a4f9ea6d46",
-        "conditions": [
+        "conditionals": [
           {
-            "condition_type": "and",
+            "_type": "and",
             "next": "56e80942-d0a4-405a-85cd-bd1b100013d6",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "48357db5-7c06-4e85-94b1-5e1c9d8f39eb",
@@ -308,9 +308,9 @@
             ]
           },
           {
-            "condition_type": "or",
+            "_type": "or",
             "next": "6324cca4-7770-4765-89b9-1cdc41f49c8b",
-            "criterias": [
+            "expressions": [
               {
                 "operator": "is",
                 "page": "48357db5-7c06-4e85-94b1-5e1c9d8f39eb",

data/fixtures/invalid_content_page.json

@@ -33,6 +33,20 @@
       ]
     }
   },
+  "flow": {
+    "9626b2e9-5ef0-4070-8331-ac55151b22c4": {
+      "_type": "flow.page",
+      "next": {
+        "default": "1ed3e4ad-5098-41c9-b4b6-426e89f7804e"
+      }
+    },
+    "1ed3e4ad-5098-41c9-b4b6-426e89f7804e": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
   "pages": [
     {
       "_uuid": "9626b2e9-5ef0-4070-8331-ac55151b22c4",
@@ -42,7 +56,6 @@
       "lede": "Use this service to:",
       "body": "Use this service to:\r\n\r\n* do something\r\n* update your name, address or other details\r\n* do something else\r\n\r\nRegistering takes around 5 minutes.",
       "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally.",
-      "steps": [],
       "url": "/"
     },
     {

data/fixtures/no_component_page.json

@@ -33,6 +33,20 @@
       ]
     }
   },
+  "flow": {
+    "9626b2e9-5ef0-4070-8331-ac55151b22c4": {
+      "_type": "flow.page",
+      "next": {
+        "default": "1ed3e4ad-5098-41c9-b4b6-426e89f7804e"
+      }
+    },
+    "b238a22f-c180-48d0-a7d9-8aad2036f1f2": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
   "pages": [
     {
       "_uuid": "9626b2e9-5ef0-4070-8331-ac55151b22c4",
@@ -42,7 +56,6 @@
       "lede": "Use this service to:",
       "body": "Use this service to:\r\n\r\n* do something\r\n* update your name, address or other details\r\n* do something else\r\n\r\nRegistering takes around 5 minutes.",
       "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally.",
-      "steps": [],
       "url": "/"
     },
     {