metadata_presenter 1.4.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e72c6d7db805dc3c408e5be910e7e8622984d6dafe879bdd488857f9ae4d44
-  data.tar.gz: 61a5d6f5430a9cf8ae6b5a0d9c6ae03f2869c59e96e70919541e031944d7b99f
+  metadata.gz: 2e8dfc341688f7dccd859058844f7b475ecc93afb86ab46d1a4d72f89c8f8235
+  data.tar.gz: cfee59590ce4834a7c8eda109cd914f1b0b0157c2d48dc97e44351b552b943fe
 SHA512:
-  metadata.gz: 83993ca5083a0c54693f7c46d14561c897c881fe9461c5ccef1881726d9e46f9f5ca69abb8faf8d619fa5ca9fcef46dee8b096b1dda30468a86a8c9a876e1350
-  data.tar.gz: ac17522430316217e5bf6c430b326dae237d60f759d6e25125fa701a265e97082238492b47cb0948fe703da6ed35fc5e5da1f54a11bbc2abd17d535001172258
+  metadata.gz: 74d388b6e903201e9d42a71ae17f7457a748b4c7791a5604b8f9ac387b56f3a5f20953a55c84ce0a60efa53ea8ac9580d291001648fa781c0b01c5c56dd43dc1
+  data.tar.gz: b4ac8ca7c331b9a4a93acec7ad58036f42d7f73f5098b247cae77b054352bf588424832e615ebad4e76ee8ec4069723cd9edfdaee65a2ef7ae4f47aaca5369b0

data/README.md

@@ -83,3 +83,15 @@ service.
 ## Generate documentation
 
 Run `rake doc` and open the doc/index.html
+
+## Flow diagrams
+
+You can generate flow diagrams calling a rake task:
+
+```
+  brew install graphviz
+  SERVICE_METADATA="some-form-metadata" rails metadata:flow
+```
+
+This will generate an image with the flow for that metadata. Open that image
+and profit!

data/app/controllers/metadata_presenter/answers_controller.rb

@@ -28,6 +28,7 @@ module MetadataPresenter
       next_page = NextPage.new(
         service: service,
         session: session,
+        user_data: load_user_data,
         current_page_url: page_url
       ).find
 

data/app/controllers/metadata_presenter/change_answer_controller.rb

@@ -1,7 +1,7 @@
 module MetadataPresenter
   class ChangeAnswerController < EngineController
     def create
-      session[:return_to_check_you_answer] = true
+      session[:return_to_check_your_answer] = true
       redirect_to_page params[:url]
     end
   end

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -6,14 +6,19 @@ module MetadataPresenter
     default_form_builder GOVUKDesignSystemFormBuilder::FormBuilder
 
     def back_link
-      return if @page.blank?
-
-      previous_page = service.previous_page(
+      previous_page = PreviousPage.new(
+        service: service,
+        user_data: load_user_data,
         current_page: @page,
-        referrer: request.referer
-      )&.url
-
-      @back_link ||= File.join(request.script_name, previous_page) if previous_page
+        referrer: request.referrer
+      ).page
+
+      if previous_page
+        @back_link ||= File.join(
+          request.script_name,
+          previous_page.url
+        )
+      end
     end
     helper_method :back_link
 

data/app/models/metadata_presenter/evaluate_conditions.rb

@@ -4,24 +4,32 @@ module MetadataPresenter
     attr_accessor :service, :flow, :user_data
 
     def page
-      results = conditions.map do |condition|
-        condition.criterias.map do |criteria|
+      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
 
-          next unless Operator.new(
+          Operator.new(
             criteria.operator
-          ).evaluate(criteria.field_label, user_data[criteria.criteria_component.id])
+          ).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
 
-      page_uuid = results.flatten.uniq.compact
-      if page_uuid.present?
-        service.find_page_by_uuid(page_uuid.first)
-      else
-        service.find_page_by_uuid(flow.default_next)
-      end
+      @results.flatten.compact.first
     end
 
     delegate :conditions, to: :flow

data/app/models/metadata_presenter/flow.rb

@@ -13,5 +13,9 @@ module MetadataPresenter
         Condition.new(condition_metadata)
       end
     end
+
+    def group_by_page
+      conditions.group_by(&:next)
+    end
   end
 end

data/app/models/metadata_presenter/next_page.rb

@@ -1,10 +1,10 @@
 module MetadataPresenter
   class NextPage
     include ActiveModel::Model
-    attr_accessor :service, :session, :current_page_url
+    attr_accessor :service, :session, :user_data, :current_page_url
 
     def find
-      return check_answers_page if return_to_check_you_answer?
+      return check_answers_page if return_to_check_your_answer?
 
       if conditions?
         evaluate_conditions
@@ -18,12 +18,12 @@ module MetadataPresenter
     private
 
     def check_answers_page
-      session[:return_to_check_you_answer] = nil
+      session[:return_to_check_your_answer] = nil
       service.pages.find { |page| page.type == 'page.checkanswers' }
     end
 
-    def return_to_check_you_answer?
-      session[:return_to_check_you_answer].present?
+    def return_to_check_your_answer?
+      session[:return_to_check_your_answer].present?
     end
 
     def conditions?
@@ -36,7 +36,7 @@ module MetadataPresenter
       EvaluateConditions.new(
         service: service,
         flow: next_flow,
-        user_data: session[:user_data]
+        user_data: user_data
       ).page
     end
 

data/app/models/metadata_presenter/page.rb

@@ -62,6 +62,10 @@ module MetadataPresenter
       components.select(&:upload?)
     end
 
+    def standalone?
+      type == 'page.standalone'
+    end
+
     private
 
     def to_components(node_components, collection:)

data/app/models/metadata_presenter/page_answers.rb

@@ -2,6 +2,7 @@ module MetadataPresenter
   class PageAnswers
     include ActiveModel::Model
     include ActiveModel::Validations
+    include ActionView::Helpers
     attr_reader :page, :answers, :uploaded_files
 
     def initialize(page, answers)
@@ -27,8 +28,10 @@ module MetadataPresenter
         date_answer(component.id)
       elsif component && component.type == 'upload'
         upload_answer(component.id)
+      elsif component && component.type == 'checkboxes'
+        answers[method_name.to_s].to_a
       else
-        answers[method_name.to_s]
+        sanitize(answers[method_name.to_s])
       end
     end
 
@@ -38,10 +41,10 @@ module MetadataPresenter
       return {} unless file_details
 
       if file_details.is_a?(Hash) || file_details.is_a?(ActionController::Parameters)
-        file_details
+        file_details.merge('original_filename' => sanitize(file_details['original_filename']))
       else
         {
-          'original_filename' => file_details.original_filename,
+          'original_filename' => sanitize(file_details.original_filename),
           'content_type' => file_details.content_type,
           'tempfile' => file_details.tempfile.path.to_s
         }
@@ -60,7 +63,7 @@ module MetadataPresenter
         GOVUKDesignSystemFormBuilder::Elements::Date::SEGMENTS[:month],
         GOVUKDesignSystemFormBuilder::Elements::Date::SEGMENTS[:year]
       ].map do |segment|
-        answers["#{component_id}(#{segment})"]
+        sanitize(answers["#{component_id}(#{segment})"])
       end
     end
   end

data/app/models/metadata_presenter/previous_page.rb

@@ -0,0 +1,38 @@
+module MetadataPresenter
+  class PreviousPage
+    include ActiveModel::Model
+    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 flow.present?
+        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
+    end
+
+    def flow
+      service.metadata['flow']
+    end
+
+    private
+
+    def referrer_page
+      @referrer_page ||= service.find_page_by_url(URI(referrer).path)
+    end
+
+    def return_to_referrer?
+      current_page.standalone? ||
+        (referrer_page && referrer_page.standalone?)
+    end
+
+    def no_current_or_referrer_pages?
+      current_page.blank? || referrer.nil?
+    end
+  end
+end

data/app/models/metadata_presenter/service.rb

@@ -39,6 +39,8 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
   end
 
   def previous_page(current_page:, referrer:)
+    return if current_page.nil? || referrer.nil?
+
     unless no_back_link?(current_page)
       flow_page(current_page) || referrer_page(referrer)
     end
@@ -54,16 +56,16 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     MetadataPresenter::Meta.new(configuration['meta'])
   end
 
+  def no_back_link?(current_page)
+    current_page == start_page || current_page == confirmation_page
+  end
+
   private
 
   def all_pages
     @all_pages ||= pages + standalone_pages
   end
 
-  def no_back_link?(current_page)
-    current_page == start_page || current_page == confirmation_page
-  end
-
   def flow_page(current_page)
     page_index = pages.index(current_page)
     pages[page_index - 1] if page_index.present?

data/app/models/metadata_presenter/traversed_pages.rb

@@ -0,0 +1,40 @@
+module MetadataPresenter
+  class TraversedPages
+    attr_reader :service, :user_data, :current_page
+
+    def initialize(service, user_data, current_page)
+      @service = service
+      @user_data = user_data
+      @pages = [service.start_page]
+      @current_page = current_page
+    end
+
+    delegate :last, to: :all
+
+    def all
+      page_uuid = service.start_page.uuid
+
+      service.metadata['flow'].size.times do
+        break if page_uuid == current_page.uuid
+
+        flow_object = service.flow(page_uuid)
+
+        if flow_object.branch?
+          page = EvaluateConditions.new(
+            service: service,
+            flow: flow_object,
+            user_data: user_data
+          ).page
+          page_uuid = page.uuid
+        else
+          page_uuid = flow_object.default_next
+          page = service.find_page_by_uuid(page_uuid)
+        end
+
+        @pages.push(page) if page && page.uuid != current_page.uuid
+      end
+
+      @pages
+    end
+  end
+end

data/app/operators/metadata_presenter/base_operator.rb

@@ -6,5 +6,15 @@ module MetadataPresenter
       @actual = actual
       @expected = expected
     end
+
+    def evaluate?
+      raise NotImplementedError
+    end
+
+    # Method signature for collection components (a.k.a checkboxes)
+    #
+    def evaluate_collection?
+      evaluate?
+    end
   end
 end

data/app/operators/metadata_presenter/is_not_operator.rb

@@ -3,5 +3,9 @@ module MetadataPresenter
     def evaluate?
       @actual != @expected
     end
+
+    def evaluate_collection?
+      Array(@expected).exclude?(@actual)
+    end
   end
 end

data/app/operators/metadata_presenter/is_operator.rb

@@ -3,5 +3,9 @@ module MetadataPresenter
     def evaluate?
       @actual == @expected
     end
+
+    def evaluate_collection?
+      Array(@expected).include?(@actual)
+    end
   end
 end

data/app/operators/metadata_presenter/operator.rb

@@ -10,10 +10,13 @@ module MetadataPresenter
     end
 
     def evaluate(actual, expected)
-      klass
-        .constantize
-        .new(actual, expected)
-        .evaluate?
+      operator = klass.constantize.new(actual, expected)
+
+      if expected.is_a?(Array)
+        operator.evaluate_collection?
+      else
+        operator.evaluate?
+      end
     rescue NameError
       raise NoOperator,
             "Operator '#{operator}' is not implemented. You need to create the class #{klass}"

data/fixtures/branching.json

@@ -137,7 +137,7 @@
     "cf8b3e18-dacf-4e91-92e1-018035961003": {
       "_type": "branch",
       "next": {
-        "default": "e337070b-f636-49a3-a65c-f506675265f0",
+        "default": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
         "conditions": [
           {
             "condition_type": "if",
@@ -154,6 +154,124 @@
         ]
       }
     },
+    "b5efc09c-ece7-45ae-b0b3-8a7905e25040": {
+      "_type": "page",
+      "next": {
+        "default": "0c022e95-0748-4dda-8ba5-12fd1d2f596b"
+      }
+    },
+    "0c022e95-0748-4dda-8ba5-12fd1d2f596b": {
+      "_type": "page",
+      "next": {
+        "default": "618b7537-b42b-4551-ae7d-053afa4d9ca9"
+      }
+    },
+    "618b7537-b42b-4551-ae7d-053afa4d9ca9": {
+      "_type": "branch",
+      "next": {
+        "default": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
+        "conditions": [
+          {
+            "condition_type": "if",
+            "next": "bc666714-c0a2-4674-afe5-faff2e20d847",
+            "criterias": [
+              {
+                "operator": "is",
+                "page": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
+                "component": "4c409737-80bb-48c7-afa7-6e9360b65004",
+                "field": "3251098f-c8e0-4ac5-a637-95fd2e1c4dc4"
+              }
+            ]
+          },
+          {
+            "condition_type": "if",
+            "next": "e2887f44-5e8d-4dc0-b1de-496ab6039430",
+            "criterias": [
+              {
+                "operator": "is_not",
+                "page": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
+                "component": "4c409737-80bb-48c7-afa7-6e9360b65004",
+                "field": "3251098f-c8e0-4ac5-a637-95fd2e1c4dc4"
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "bc666714-c0a2-4674-afe5-faff2e20d847": {
+      "_type": "page",
+      "next": {
+        "default": "dc7454f9-4186-48d7-b055-684d57bbcdc7"
+      }
+    },
+    "e2887f44-5e8d-4dc0-b1de-496ab6039430": {
+      "_type": "page",
+      "next": {
+        "default": "dc7454f9-4186-48d7-b055-684d57bbcdc7"
+      }
+    },
+    "dc7454f9-4186-48d7-b055-684d57bbcdc7": {
+      "_type": "page",
+      "next": {
+        "default": "84a347fc-8d4b-486a-9996-6a86fa9544c5"
+      }
+    },
+    "84a347fc-8d4b-486a-9996-6a86fa9544c5": {
+      "_type": "branch",
+      "next": {
+        "default": "e337070b-f636-49a3-a65c-f506675265f0",
+        "conditions": [
+          {
+            "condition_type": "or",
+            "next": "2cc66e51-2c14-4023-86bf-ded49887cdb2",
+            "criterias": [
+              {
+                "operator": "is",
+                "page": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
+                "component": "5ca01e56-94de-4c33-b5fc-74697e5b95cc",
+                "field": "bd14bf31-427e-4267-9926-a18c167fe604"
+              },
+              {
+                "operator": "is",
+                "page": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
+                "component": "5ca01e56-94de-4c33-b5fc-74697e5b95cc",
+                "field": "eb720ef7-bcaf-4c73-8972-6fc80dca6245"
+              }
+            ]
+          },
+          {
+            "condition_type": "and",
+            "next": "f6c51f88-7be8-4cb7-bbfc-6c905727a051",
+            "criterias": [
+              {
+                "operator": "is",
+                "page": "68fbb180-9a2a-48f6-9da6-545e28b8d35a",
+                "component": "ac41be35-914e-4b22-8683-f5477716b7d4",
+                "field": "c5571937-9388-4411-b5fa-34ddf9bc4ca0"
+              },
+              {
+                "operator": "is",
+                "page": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
+                "component": "5ca01e56-94de-4c33-b5fc-74697e5b95cc",
+                "field": "0c4192eb-1441-4f10-b00a-0f03b756269e"
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "2cc66e51-2c14-4023-86bf-ded49887cdb2": {
+      "_type": "page",
+      "next": {
+        "default": "e337070b-f636-49a3-a65c-f506675265f0"
+      }
+    },
+    "f6c51f88-7be8-4cb7-bbfc-6c905727a051": {
+      "_type": "page",
+      "next": {
+        "default": "e337070b-f636-49a3-a65c-f506675265f0"
+      }
+    },
     "e337070b-f636-49a3-a65c-f506675265f0": {
       "_type": "page",
       "next": {
@@ -608,6 +726,217 @@
         }
       ]
     },
+    {
+      "_id": "page.burgers",
+      "url": "burgers",
+      "body": "Body section",
+      "lede": "",
+      "_type": "page.singlequestion",
+      "_uuid": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
+      "heading": "Question",
+      "components": [
+        {
+          "_id": "burgers_checkboxes_1",
+          "hint": "",
+          "name": "burgers_checkboxes_1",
+          "_type": "checkboxes",
+          "_uuid": "4c409737-80bb-48c7-afa7-6e9360b65004",
+          "items": [
+            {
+              "_id": "burgers_checkboxes_1_item_1",
+              "hint": "",
+              "name": "burgers_checkboxes_1",
+              "_type": "checkbox",
+              "_uuid": "3251098f-c8e0-4ac5-a637-95fd2e1c4dc4",
+              "label": "Beef, cheese, tomato",
+              "value": "value-1",
+              "errors": {},
+              "legend": "Question",
+              "collection": "components",
+              "validation": {
+                "required": true
+              }
+            },
+            {
+              "_id": "burgers_checkboxes_1_item_2",
+              "hint": "",
+              "name": "burgers_checkboxes_1",
+              "_type": "checkbox",
+              "_uuid": "a0717bbd-0b9f-47a0-bf2b-2a9d208e1168",
+              "label": "Chicken, cheese, tomato",
+              "value": "value-2",
+              "errors": {},
+              "legend": "Question",
+              "collection": "components",
+              "validation": {
+                "required": true
+              }
+            },
+            {
+              "_id": "burgers_checkboxes_1_item_3",
+              "hint": "",
+              "name": "burgers_checkboxes_1",
+              "_type": "checkbox",
+              "_uuid": "4c409737-80bb-48c7-afa7-6e9360b65004",
+              "label": "Mozzarella, cheddar, feta",
+              "value": "value-3",
+              "errors": {},
+              "legend": "Question",
+              "collection": "components",
+              "validation": {
+                "required": true
+              }
+            }
+          ],
+          "errors": {},
+          "legend": "What would you like on your burger?",
+          "collection": "components",
+          "validation": {
+            "required": false
+          }
+        }
+      ]
+    },
+    {
+      "_id": "page.global-warming",
+      "url": "global-warming",
+      "body": "What about the trees?",
+      "lede": "",
+      "_type": "page.content",
+      "_uuid": "bc666714-c0a2-4674-afe5-faff2e20d847",
+      "heading": "Global warming",
+      "components": [
+        {
+          "_id": "global-warming_content_1",
+          "name": "global-warming_content_1",
+          "_type": "content",
+          "_uuid": "957917c3-7473-4c30-b713-5aae77a1c22f",
+          "content": "They will come for you"
+        }
+      ],
+      "section_heading": ""
+    },
+    {
+      "_id": "page.we-love-chickens",
+      "url": "we-love-chickens",
+      "body": "Cluck cluck",
+      "lede": "",
+      "_type": "page.content",
+      "_uuid": "e2887f44-5e8d-4dc0-b1de-496ab6039430",
+      "heading": "We love chickens",
+      "components": [
+        {
+          "_id": "global-warming_content_1",
+          "name": "global-warming_content_1",
+          "_type": "content",
+          "_uuid": "49ff5c79-2e63-45fe-bbf7-de0bd061b909",
+          "content": "Cruella ain't got nothing on Cluckeralla"
+        }
+      ],
+      "section_heading": ""
+    },
+    {
+      "_id": "page.marvel-series",
+      "url": "marvel-series",
+      "_type": "page.singlequestion",
+      "_uuid": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
+      "components": [
+        {
+          "_id": "marvel-series_radios_1",
+          "hint": "",
+          "name": "marvel-series_radios_1",
+          "_type": "radios",
+          "_uuid": "5ca01e56-94de-4c33-b5fc-74697e5b95cc",
+          "items": [
+            {
+              "_id": "marvel-series_radios_1_item_1",
+              "hint": "",
+              "_type": "radio",
+              "_uuid": "0c4192eb-1441-4f10-b00a-0f03b756269e",
+              "label": "WandaVision"
+            },
+            {
+              "_id": "marvel-series_radios_1_item_2",
+              "hint": "",
+              "_type": "radio",
+              "_uuid": "bd14bf31-427e-4267-9926-a18c167fe604",
+              "label": "The Falcon and the Winter Soldier"
+            },
+            {
+              "_id": "marvel-series_radios_1_item_2",
+              "hint": "",
+              "_type": "radio",
+              "_uuid": "eb720ef7-bcaf-4c73-8972-6fc80dca6245",
+              "label": "Loki"
+            },
+            {
+              "_id": "marvel-series_radios_1_item_3",
+              "hint": "",
+              "_type": "radio",
+              "_uuid": "d762e328-18dc-4861-bca8-d104609b8299",
+              "label": "Hawkeye"
+            }
+          ],
+          "errors": {},
+          "legend": "What is the best marvel series?",
+          "validation": {
+            "required": true
+          }
+        }
+      ]
+    },
+    {
+      "_id": "page.marvel-quotes",
+      "url": "marvel-quotes",
+      "body": "Marvel quotes",
+      "lede": "",
+      "_type": "page.content",
+      "_uuid": "2cc66e51-2c14-4023-86bf-ded49887cdb2",
+      "heading": "Loki",
+      "components": [
+        {
+          "_id": "marvel-quotes_content_1",
+          "name": "marvel-quotes_content_1",
+          "_type": "content",
+          "_uuid": "5cede2fa-5001-4d6a-965c-30addc3c4496",
+          "content": "I am Loki of Asgard, and I am burdened with glorious purpose."
+        },
+        {
+          "_id": "marvel-quotes_content_2",
+          "name": "marvel-quotes_content_2",
+          "_type": "content",
+          "_uuid": "816b6afd-4649-455a-b10d-62cb5acb4584",
+          "content": "So Who Are You Fighting Now ... Gandalf?"
+        }
+      ],
+      "section_heading": ""
+    },
+    {
+      "_id": "page.other-quotes",
+      "url": "other-quotes",
+      "body": "Other quotes",
+      "lede": "",
+      "_type": "page.content",
+      "_uuid": "f6c51f88-7be8-4cb7-bbfc-6c905727a051",
+      "heading": "Other quotes",
+      "components": [
+        {
+          "_id": "other-quotes_content_1",
+          "name": "other-quotes_content_1",
+          "_type": "content",
+          "_uuid": "2535a867-deab-457b-91aa-c006e3c73d63",
+          "content": "- How we doing? - Same as always... - That bad, huh?"
+        },
+        {
+          "_id": "other-quotes_content_2",
+          "name": "other-quotes_content_2",
+          "_type": "content",
+          "_uuid": "816b6afd-4649-455a-b10d-62cb5acb4584",
+          "content": "Are you using your night vision, Vision?"
+        }
+      ],
+      "section_heading": ""
+    },
     {
       "_id": "page.check-answers",
       "url": "check-answers",
@@ -655,7 +984,7 @@
   "created_by": "099d5bf5-5f7b-444c-86ee-9e189cc1a369",
   "service_id": "488edccd-8411-4ffb-a38b-6a96c6ac28d6",
   "version_id": "27dc30c9-f7b8-4dec-973a-bd153f6797df",
-  "service_name": "Version Fixture",
+  "service_name": "Branching Fixture",
   "configuration": {
     "meta": {
       "_id": "config.meta",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.7.1'.freeze
 end

data/lib/tasks/metadata_presenter_tasks.rake

@@ -1,4 +1,89 @@
-# desc "Explaining what the task does"
-# task :metadata_presenter do
-#   # Task goes here
-# end
+require 'metadata_presenter/test_helpers'
+
+namespace :metadata do
+  include MetadataPresenter::TestHelpers
+
+  desc 'Represent the flow objects in human readable form'
+  task flow: :environment do
+    require 'ruby-graphviz'
+    metadata = ENV['SERVICE_METADATA'] || metadata_fixture('branching')
+    service = MetadataPresenter::Service.new(metadata)
+
+    graph = MetadataPresenter::Graph.new(service)
+
+    graph.draw.generate_image
+    puts "Generated file #{graph.filename}"
+    system("open #{graph.filename}")
+  end
+end
+
+module MetadataPresenter
+  class Graph
+    attr_reader :service, :filename, :nodes
+
+    delegate :metadata, :start_page, :find_page_by_uuid, :service_slug, to: :service
+
+    def initialize(service)
+      @service = service
+      @graphviz = GraphViz.new(:G, type: :digraph)
+      @filename = Rails.root.join('tmp', "#{service_slug}.png")
+      @nodes = {}
+    end
+
+    def draw
+      draw_nodes
+      draw_edges
+
+      self
+    end
+
+    def generate_image
+      @graphviz.output(png: filename)
+    end
+
+    private
+
+    def draw_nodes
+      flow.each do |id, _value|
+        flow_object = service.flow(id)
+
+        if flow_object.branch?
+          full_description = flow_object.conditions.map do |condition|
+            condition.criterias.map do |criteria|
+              criteria.service = service
+
+              "if #{criteria.criteria_component.humanised_title} #{criteria.operator} #{criteria.field_label}"
+            end
+          end
+          nodes[id] = @graphviz.add_nodes(full_description.flatten.join(' - '))
+        else
+          current_page = find_page_by_uuid(id)
+          nodes[id] = @graphviz.add_nodes(current_page.url)
+        end
+      end
+    end
+
+    def draw_edges
+      flow.each do |id, _value|
+        flow_object = service.flow(id)
+        current_node = nodes[id]
+        node_next = nodes[flow_object.default_next]
+
+        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
+          end
+        elsif node_next
+          @graphviz.add_edges(current_node, node_next)
+        end
+      end
+    end
+
+    def flow
+      metadata['flow']
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.1
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -128,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -277,7 +291,9 @@ files:
 - app/models/metadata_presenter/offline_upload_adapter.rb
 - app/models/metadata_presenter/page.rb
 - app/models/metadata_presenter/page_answers.rb
+- app/models/metadata_presenter/previous_page.rb
 - app/models/metadata_presenter/service.rb
+- app/models/metadata_presenter/traversed_pages.rb
 - app/models/metadata_presenter/uploaded_file.rb
 - app/operators/metadata_presenter/base_operator.rb
 - app/operators/metadata_presenter/is_answered_operator.rb