metadata_presenter 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaea9e08a797416b551fd731c80db49d05f02f75f4ac61ecf68c5861d55af9a3
-  data.tar.gz: e3938447849a5197cc3567c55caacdf0eea2e80e1e4eb05b42e175850d9b34cd
+  metadata.gz: 37dfa1fbf4a8bd66310d1fa2e21f6c7a537806298a4cbc9b036f4a3af841262b
+  data.tar.gz: cd9ccaf657f85e4c5ac9b5513b74d3d956be16435958e55deb9bae9d7079a2cf
 SHA512:
-  metadata.gz: 4f9ac675b0c24ca6ea9a1a9556b13a1151d499750e8aa16d3fbfc5981ac2a93cb99acc03939a188886eaf1254930bcdc1634fd44461b4345ec029a0243bd4d73
-  data.tar.gz: bf12bf7eefe0f0376fe67801fa74507d0a8267c08106b8c0198023f09999a093090127d4f6b3e8360d2e570cc90a49a36f4263ed77b63dc2e56587ad605a95fd
+  metadata.gz: dbc2c13d435a9ab81a7a09d6e68a1a0ba782f0fbbffa6e9704b696bf69c54ce7518d6254b0ce918a651c96985087a90e5caac7b56968c42eb89e60bb8a2d82c6
+  data.tar.gz: 9829ce7cd18ba363aad94ec5d785cbcd5eb22edd13e41fd8bbe76f1f882db7778223971ef4e53dc31bae23a17a91033c9926bd4d256156f95d4993b2df6ced32

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/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/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/fixtures/branching.json

@@ -820,7 +820,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.5.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/tasks/metadata_presenter_tasks.rake

@@ -5,48 +5,86 @@ namespace :metadata do
 
   desc 'Represent the flow objects in human readable form'
   task flow: :environment do
-    service = MetadataPresenter::Service.new(metadata_fixture('branching'))
-
-    start_page = service.start_page
-    flow = service.flow(start_page.uuid)
-    first_page = service.find_page_by_uuid(flow.default_next)
-
-    humanized_flow = {}
-
-    humanized_flow[start_page.url] = {
-      next: first_page.url
-    }
-
-    service.metadata['flow'].each do |id, _metadata|
-      flow = service.flow(id)
-
-      if flow.branch?
-        page = service.find_page_by_uuid(flow.default_next)
-        humanized_flow[page.url] = {
-          conditions: flow.conditions.map do |condition|
-            {
-              condition_type: condition.condition_type,
-              criterias: condition.criterias.map do |criteria|
-                criteria.service = service
-                {
-                  operator: criteria.operator,
-                  page: criteria.criteria_page.url,
-                  component: criteria.criteria_component.humanised_title,
-                  field: criteria.field_label
-                }
-              end
-            }
+    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
+
+require 'ruby-graphviz'
+
+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
-        }
-      else
-        page = service.find_page_by_uuid(id)
-        next_page = service.find_page_by_uuid(flow.default_next)
-        if next_page
-          humanized_flow[page.url] = { next: next_page.url }
+          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
 
-    pp humanized_flow
+    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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-01 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