metadata_presenter 1.8.1 → 2.0.2

data/fixtures/non_finished_service.json

@@ -34,23 +34,46 @@
       ]
     }
   },
+  "flow": {
+    "cf6dc32f-502c-4215-8c27-1151a45735bb": {
+      "_type": "flow.page",
+      "next": {
+        "default": "9e1ba77f-f1e5-42f4-b090-437aa9af7f73"
+      }
+    },
+    "9e1ba77f-f1e5-42f4-b090-437aa9af7f73": {
+      "_type": "flow.page",
+      "next": {
+        "default": "68fbb180-9a2a-48f6-9da6-545e28b8d35a"
+      }
+    },
+    "68fbb180-9a2a-48f6-9da6-545e28b8d35a": {
+      "_type": "flow.page",
+      "next": {
+        "default": "09e91fd9-7a46-4840-adbc-244d545cfef7"
+      }
+    },
+    "09e91fd9-7a46-4840-adbc-244d545cfef7": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
   "pages": [
     {
       "_id": "page.start",
       "_type": "page.start",
+      "_uuid": "cf6dc32f-502c-4215-8c27-1151a45735bb",
       "heading": "Service name goes here",
       "lede": "This is your start page first paragraph. You can only have one paragraph here.",
       "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.",
-      "steps": [
-        "page.name",
-        "page.email-address",
-        "page.parent_name"
-      ],
       "url": "/"
     },
     {
       "_id": "page.name",
       "_type": "page.singlequestion",
+      "_uuid": "9e1ba77f-f1e5-42f4-b090-437aa9af7f73",
       "components": [
         {
           "_id": "page.name--text.auto_name__1",
@@ -70,6 +93,7 @@
     {
       "_id": "page.email-address",
       "_type": "page.singlequestion",
+      "_uuid": "68fbb180-9a2a-48f6-9da6-545e28b8d35a",
       "heading": "Email address",
       "components": [
         {
@@ -101,6 +125,7 @@
     {
       "_id": "page.parent_name",
       "_type": "page.singlequestion",
+      "_uuid": "09e91fd9-7a46-4840-adbc-244d545cfef7",
       "components": [
         {
           "_id": "page.parent-name--text.auto_name__3",

data/fixtures/service.json

@@ -1,6 +1,14 @@
 {
   "_id": "service.base",
   "_type": "service.base",
+  "flow": {
+    "86ed04ac-1727-4172-8dd2-608009f1a656": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
   "pages": [
     {
       "_id": "page.start",
@@ -9,7 +17,6 @@
       "lede": "",
       "_type": "page.start",
       "_uuid": "86ed04ac-1727-4172-8dd2-608009f1a656",
-      "steps": [],
       "heading": "Service name goes here",
       "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."
     }

data/fixtures/version.json

@@ -1,6 +1,92 @@
 {
   "_id": "service.base",
   "_type": "service.base",
+  "flow": {
+    "cf6dc32f-502c-4215-8c27-1151a45735bb": {
+      "_type": "flow.page",
+      "next": {
+        "default": "9e1ba77f-f1e5-42f4-b090-437aa9af7f73"
+      }
+    },
+    "9e1ba77f-f1e5-42f4-b090-437aa9af7f73": {
+      "_type": "flow.page",
+      "next": {
+        "default": "df1ba645-f748-46d0-ad75-f34112653e37"
+      }
+    },
+    "df1ba645-f748-46d0-ad75-f34112653e37": {
+      "_type": "flow.page",
+      "next": {
+        "default": "4b8c6bf3-878a-4446-9198-48351b3e2185"
+      }
+    },
+    "4b8c6bf3-878a-4446-9198-48351b3e2185": {
+      "_type": "flow.page",
+      "next": {
+        "default": "54ccc6cd-60c0-4749-947b-a97af1bc0aa2"
+      }
+    },
+    "54ccc6cd-60c0-4749-947b-a97af1bc0aa2": {
+      "_type": "flow.page",
+      "next": {
+        "default": "b8335af2-6642-4e2f-8192-0dd12279eec7"
+      }
+    },
+    "b8335af2-6642-4e2f-8192-0dd12279eec7": {
+      "_type": "flow.page",
+      "next": {
+        "default": "68fbb180-9a2a-48f6-9da6-545e28b8d35a"
+      }
+    },
+    "68fbb180-9a2a-48f6-9da6-545e28b8d35a": {
+      "_type": "flow.page",
+      "next": {
+        "default": "7806cd64-0c05-450e-ba6f-2325c8b22d46"
+      }
+    },
+    "7806cd64-0c05-450e-ba6f-2325c8b22d46": {
+      "_type": "flow.page",
+      "next": {
+        "default": "0c022e95-0748-4dda-8ba5-12fd1d2f596b"
+      }
+    },
+    "0c022e95-0748-4dda-8ba5-12fd1d2f596b": {
+      "_type": "flow.page",
+      "next": {
+        "default": "e8708909-922e-4eaf-87a5-096f7a713fcb"
+      }
+    },
+    "e8708909-922e-4eaf-87a5-096f7a713fcb": {
+      "_type": "flow.page",
+      "next": {
+        "default": "80420693-d6f2-4fce-a860-777ca774a6f5"
+      }
+    },
+    "80420693-d6f2-4fce-a860-777ca774a6f5": {
+      "_type": "flow.page",
+      "next": {
+        "default": "2ef7d11e-0307-49e9-9fe2-345dc528dd66"
+      }
+    },
+    "2ef7d11e-0307-49e9-9fe2-345dc528dd66": {
+      "_type": "flow.page",
+      "next": {
+        "default": "e337070b-f636-49a3-a65c-f506675265f0"
+      }
+    },
+    "e337070b-f636-49a3-a65c-f506675265f0": {
+      "_type": "flow.page",
+      "next": {
+        "default": "778e364b-9a7f-4829-8eb2-510e08f156a3"
+      }
+    },
+    "778e364b-9a7f-4829-8eb2-510e08f156a3": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
   "pages": [
     {
       "_id": "page.start",
@@ -9,21 +95,6 @@
       "lede": "",
       "_type": "page.start",
       "_uuid": "cf6dc32f-502c-4215-8c27-1151a45735bb",
-      "steps": [
-        "page.name",
-        "page.email-address",
-        "page.parent-name",
-        "page.your-age",
-        "page.family-hobbies",
-        "page.do-you-like-star-wars",
-        "page.holiday",
-        "page.burgers",
-        "page.star-wars-knowledge",
-        "page.how-many-lights",
-        "page.dog-picture",
-        "page.check-answers",
-        "page.confirmation"
-      ],
       "heading": "Service name goes here",
       "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."
     },

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '1.8.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/lib/tasks/metadata_presenter_tasks.rake

@@ -48,12 +48,12 @@ module MetadataPresenter
         flow_object = service.flow_object(id)
 
         if flow_object.branch?
-          full_description = flow_object.conditions.map.each_with_index do |condition, _index|
-            condition.criterias.map { |criteria|
-              criteria.service = service
+          full_description = flow_object.conditionals.map.each_with_index do |conditional, _index|
+            conditional.expressions.map { |expression|
+              expression.service = service
 
-              "#{criteria.criteria_component.humanised_title} #{criteria.operator} #{criteria.field_label}"
-            }.join(" #{condition.condition_type} ")
+              "#{expression.expression_component.humanised_title} #{expression.operator} #{expression.field_label}"
+            }.join(" #{conditional.type} ")
           end
           nodes[id] = @graphviz.add_nodes(full_description.flatten.join(' / '))
         else
@@ -72,9 +72,9 @@ module MetadataPresenter
         if flow_object.branch?
           @graphviz.add_edges(current_node, node_next, label: 'Conditions are not met', labelfontsize: 8) if node_next
 
-          flow_object.group_by_page.each do |page_uuid, _conditions|
-            conditions_node = nodes[page_uuid]
-            @graphviz.add_edges(current_node, conditions_node, label: 'Conditions are met', labelfontsize: 8) if conditions_node
+          flow_object.group_by_page.each do |page_uuid, _conditionals|
+            conditionals_node = nodes[page_uuid]
+            @graphviz.add_edges(current_node, conditionals_node, label: 'Conditions are met', labelfontsize: 8) if conditionals_node
           end
         elsif node_next
           @graphviz.add_edges(current_node, node_next)

data/schemas/flow/branch.json

@@ -15,20 +15,20 @@
         "default": {
           "type": "string"
         },
-        "conditions": {
-          "$ref": "#/definitions/conditions"
+        "conditionals": {
+          "$ref": "#/definitions/conditionals"
         }
       }
     }
   },
   "additionalProperties": false,
   "definitions": {
-    "conditions": {
+    "conditionals": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "condition_type": {
+          "_type": {
             "type": "string",
             "enum": [
               "if",
@@ -39,13 +39,13 @@
           "next": {
             "type": "string"
           },
-          "criterias": {
-            "$ref": "#/definitions/criterias"
+          "expressions": {
+            "$ref": "#/definitions/expressions"
           }
         }
       }
     },
-    "criterias": {
+    "expressions": {
       "type": "array",
       "items": {
         "type": "object",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 2.0.2
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -277,10 +277,10 @@ files:
 - app/helpers/metadata_presenter/default_text.rb
 - app/jobs/metadata_presenter/application_job.rb
 - app/models/metadata_presenter/component.rb
-- app/models/metadata_presenter/condition.rb
-- app/models/metadata_presenter/criteria.rb
+- app/models/metadata_presenter/conditional.rb
 - app/models/metadata_presenter/date_field.rb
-- app/models/metadata_presenter/evaluate_conditions.rb
+- app/models/metadata_presenter/evaluate_conditionals.rb
+- app/models/metadata_presenter/expression.rb
 - app/models/metadata_presenter/file_uploader.rb
 - app/models/metadata_presenter/flow.rb
 - app/models/metadata_presenter/item.rb
@@ -359,8 +359,8 @@ files:
 - default_metadata/definition/checkbox.json
 - default_metadata/definition/radio.json
 - default_metadata/flow/branch.json
-- default_metadata/flow/condition.json
-- default_metadata/flow/criteria.json
+- default_metadata/flow/conditional.json
+- default_metadata/flow/expression.json
 - default_metadata/flow/page.json
 - default_metadata/page/checkanswers.json
 - default_metadata/page/confirmation.json
@@ -382,12 +382,9 @@ files:
 - fixtures/branching.json
 - fixtures/invalid_content_page.json
 - fixtures/no_component_page.json
-- fixtures/no_flow_service.json
 - fixtures/non_finished_service.json
 - fixtures/service.json
-- fixtures/service_with_flow.json
 - fixtures/version.json
-- fixtures/version_with_flow.json
 - lib/metadata_presenter.rb
 - lib/metadata_presenter/engine.rb
 - lib/metadata_presenter/test_helpers.rb

data/app/models/metadata_presenter/condition.rb

@@ -1,13 +0,0 @@
-module MetadataPresenter
-  class Condition < MetadataPresenter::Metadata
-    def ==(other)
-      metadata.to_h.deep_symbolize_keys == other.metadata.to_h.deep_symbolize_keys
-    end
-
-    def criterias
-      Array(metadata.criterias).map do |criteria|
-        MetadataPresenter::Criteria.new(criteria)
-      end
-    end
-  end
-end

data/app/models/metadata_presenter/criteria.rb

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

data/app/models/metadata_presenter/evaluate_conditions.rb

@@ -1,37 +0,0 @@
-module MetadataPresenter
-  class EvaluateConditions
-    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 ||= conditions.map do |condition|
-        evaluated_criterias = condition.criterias.map do |criteria|
-          criteria.service = service
-
-          Operator.new(
-            criteria.operator
-          ).evaluate(
-            criteria.field_label,
-            user_data[criteria.criteria_component.id]
-          )
-        end
-
-        if condition.condition_type == 'or' && evaluated_criterias.any?
-          condition.next
-        elsif evaluated_criterias.all?
-          condition.next
-        end
-      end
-
-      @results.flatten.compact.first
-    end
-
-    delegate :conditions, to: :flow
-  end
-end

data/default_metadata/flow/condition.json

@@ -1,5 +0,0 @@
-{
-  "condition_type": "",
-  "next": "",
-  "criterias": []
-}

data/fixtures/no_flow_service.json

@@ -1,190 +0,0 @@
-{
-  "_id": "service.base",
-  "_type": "service.base",
-  "pages": [
-    {
-      "_id": "page.start",
-      "url": "/",
-      "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.",
-      "lede": "",
-      "_type": "page.start",
-      "_uuid": "cf6dc32f-502c-4215-8c27-1151a45735bb",
-      "steps": [
-        "page.name",
-        "page.email-address",
-        "page.parent-name",
-        "page.check-answers",
-        "page.confirmation"
-      ],
-      "heading": "Service name goes here",
-      "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."
-    },
-    {
-      "_id": "page.name",
-      "url": "name",
-      "body": "Body section",
-      "lede": "",
-      "_type": "page.singlequestion",
-      "_uuid": "9e1ba77f-f1e5-42f4-b090-437aa9af7f73",
-      "heading": "Question",
-      "components": [
-        {
-          "_id": "name_text_1",
-          "hint": "",
-          "name": "name_text_1",
-          "_type": "text",
-          "_uuid": "27d377a2-6828-44ca-87d1-b83ddac98284",
-          "label": "Full name",
-          "errors": {},
-          "collection": "components",
-          "validation": {
-            "required": true,
-            "max_length": 10,
-            "min_length": 2
-          }
-        }
-      ]
-    },
-    {
-      "_id": "page.email-address",
-      "url": "email-address",
-      "body": "Body section",
-      "lede": "",
-      "_type": "page.singlequestion",
-      "_uuid": "df1ba645-f748-46d0-ad75-f34112653e37",
-      "heading": "Question",
-      "components": [
-        {
-          "_id": "email-address_text_1",
-          "hint": "",
-          "name": "email-address_text_1",
-          "_type": "text",
-          "_uuid": "f27e5788-e784-4bfd-8b21-2fab8ce95abb",
-          "label": "Email address",
-          "errors": {
-            "format": {},
-            "required": {
-              "any": "Enter an email address"
-            },
-            "max_length": {
-              "any": "%{control} is too long."
-            },
-            "min_length": {
-              "any": "%{control} is too short."
-            }
-          },
-          "collection": "components",
-          "validation": {
-            "required": true,
-            "max_length": 30,
-            "min_length": 2
-          }
-        }
-      ]
-    },
-    {
-      "_id": "page.parent-name",
-      "url": "parent-name",
-      "body": "Body section",
-      "lede": "",
-      "_type": "page.singlequestion",
-      "_uuid": "4b8c6bf3-878a-4446-9198-48351b3e2185",
-      "heading": "Question",
-      "components": [
-        {
-          "_id": "parent-name_text_1",
-          "hint": "",
-          "name": "parent-name_text_1",
-          "_type": "text",
-          "_uuid": "5ad372fa-ed35-477f-b471-4d444f991210",
-          "label": "Parent name",
-          "errors": {},
-          "collection": "components",
-          "validation": {
-            "required": false,
-            "max_length": 10,
-            "min_length": 2
-          }
-        }
-      ]
-    },
-    {
-      "_id": "page.check-answers",
-      "url": "check-answers",
-      "_type": "page.checkanswers",
-      "_uuid": "e337070b-f636-49a3-a65c-f506675265f0",
-      "heading": "Check your answers",
-      "send_body": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct.",
-      "components": [
-        {
-          "_id": "check-answers_content_2",
-          "name": "check-answers_content_2",
-          "_type": "content",
-          "_uuid": "b065ff4f-90c5-4ba2-b4ac-c984a9dd2470",
-          "content": "Take the cannoli.",
-          "collection": "components"
-        }
-      ],
-      "send_heading": "Now send your application",
-      "add_component": "content",
-      "extra_components": [
-        {
-          "_id": "check-answers_content_1",
-          "name": "check-answers_content_1",
-          "_type": "content",
-          "_uuid": "3e6ef27e-91a6-402f-8291-b7ce669e824e",
-          "content": "Check yourself before you wreck yourself.",
-          "collection": "extra_components"
-        }
-      ],
-      "add_extra_component": "content"
-    },
-    {
-      "_id": "page.confirmation",
-      "url": "confirmation",
-      "body": "Some day I will be the most powerful Jedi ever!",
-      "lede": "",
-      "_type": "page.confirmation",
-      "_uuid": "778e364b-9a7f-4829-8eb2-510e08f156a3",
-      "heading": "Complaint sent",
-      "components": []
-    }
-  ],
-  "locale": "en",
-  "created_at": "2021-04-21T13:10:19Z",
-  "created_by": "099d5bf5-5f7b-444c-86ee-9e189cc1a369",
-  "service_id": "488edccd-8411-4ffb-a38b-6a96c6ac28d6",
-  "version_id": "27dc30c9-f7b8-4dec-973a-bd153f6797df",
-  "service_name": "No Flow Service Fixture",
-  "configuration": {
-    "meta": {
-      "_id": "config.meta",
-      "_type": "config.meta",
-      "items": [
-        {
-          "_id": "config.meta--link",
-          "href": "cookies",
-          "text": "Cookies",
-          "_type": "link"
-        },
-        {
-          "_id": "config.meta--link--2",
-          "href": "privacy",
-          "text": "Privacy",
-          "_type": "link"
-        },
-        {
-          "_id": "config.meta--link--3",
-          "href": "accessibility",
-          "text": "Accessibility",
-          "_type": "link"
-        }
-      ]
-    },
-    "service": {
-      "_id": "config.service",
-      "_type": "config.service"
-    }
-  },
-  "standalone_pages": []
-}