metadata_presenter 2.14.0 → 2.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42603519130d7f5029066830adc145fe8800465f38493f5acfe37943623210b9
-  data.tar.gz: 9cb6b248e8246c2b0145f6d746043680494fd7292a36d2e18dff619cf55af8dc
+  metadata.gz: ed17e32c3e0222e86ec8935840dd5830d8ed5390275ec2aa66a667765a2a654c
+  data.tar.gz: 33a20608a8f1af401191298821709f81df9da87635daecaf04ff56c03e6f79c0
 SHA512:
-  metadata.gz: 354e08330a417e94180c4686e058eac97155e2b62440faabdf1e10b17d469d2e7b93a0fd155d5d3eeb71549f2fc6725c78e048ac442c5a5b6dfeaae3f81c09e9
-  data.tar.gz: 22011caef879554eb407f7bbda3726b5255178eb51b15e095c3409ec84f97df6ed565382f51651801f0ee9686b895ffc1db92ee9f4e715baa957e4378b88eee9
+  metadata.gz: 6def253d26c9e957934d524a0d2dca9c5871cc7867114c7904d739338da7526967853583d8f2274deb7f751cd98aea9de956d2acf1af519b8853a1947784320f
+  data.tar.gz: 0e0075aa9e08a231f76ebe37bfa4767a051617606d6a7889d7a515c1dc8d2bfc2b8c65b6b44f901066b8a7fd86b9331f37ee9f02788195b67308d9652d4a0d4b

data/app/models/metadata_presenter/column_number.rb

@@ -9,6 +9,10 @@ module MetadataPresenter
 
     def number
       if service.flow_object(uuid).branch?
+        # Even though we are associating the column number to a specific flow object
+        # in the Coordinates model we do not use column_number + 1 as we are
+        # updating the position for the Spacers that exist for a branch which
+        # are always in the same column as the branch object itself.
         coordinates.set_branch_spacers_column(uuid, column_number)
       end
 

data/app/models/metadata_presenter/coordinates.rb

@@ -39,7 +39,7 @@ module MetadataPresenter
     end
 
     def set_branch_spacers_column(branch_uuid, column)
-      branch_spacers[branch_uuid].each do |position|
+      branch_spacers[branch_uuid].each do |_, position|
         position[:column] = column
       end
     end
@@ -50,7 +50,7 @@ module MetadataPresenter
     # to draw an arrow therefore we increment the row number from the branches
     # calculated starting row
     def set_branch_spacers_row(branch_uuid, starting_row)
-      branch_spacers[branch_uuid].each.with_index(starting_row) do |position, row|
+      branch_spacers[branch_uuid].each.with_index(starting_row) do |(_, position), row|
         position[:row] = row
       end
     end
@@ -64,12 +64,14 @@ module MetadataPresenter
       service.flow.keys.index_with { |_uuid| { row: nil, column: nil } }
     end
 
-    # This also takes into account the 'or' expressions which
+    # This also takes into account the 'OR' expressions which
     # need an additional line for an arrow.
     def setup_branch_spacers
       service.branches.each.with_object({}) do |branch, hash|
         destinations = exiting_destinations_from_branch(branch)
-        hash[branch.uuid] = destinations.map { { row: nil, column: nil } }
+        hash[branch.uuid] = destinations.index_with do |_uuid|
+          { row: nil, column: nil }
+        end
       end
     end
   end

data/app/models/metadata_presenter/grid.rb

@@ -19,7 +19,7 @@ module MetadataPresenter
 
   class Grid
     include BranchDestinations
-    attr_reader :start_from
+    attr_reader :service, :start_from
 
     def initialize(service, start_from: nil, main_flow: [])
       @service = service
@@ -67,9 +67,13 @@ module MetadataPresenter
       ordered_pages.map(&:uuid)
     end
 
+    def show_warning?
+      checkanswers_warning.show_warning? || confirmation_warning.show_warning?
+    end
+
     private
 
-    attr_reader :service, :main_flow
+    attr_reader :main_flow
     attr_accessor :ordered, :traversed, :routes, :coordinates
 
     def route_from_start
@@ -277,46 +281,21 @@ module MetadataPresenter
     # Include a warning if a service does not have a CYA or Confirmation page in the
     # main flow. The warning should always be in the first row, last column.
     def insert_warning
-      if cya_and_confirmation_pages_not_in_service? ||
-          cya_and_confirmation_pages_detached?
-        @ordered.append([MetadataPresenter::Warning.new])
-      end
-    end
-
-    def cya_and_confirmation_pages_not_in_service?
-      (checkanswers_not_in_service? && confirmation_not_in_service?) ||
-        checkanswers_not_in_service? ||
-        confirmation_not_in_service?
-    end
-
-    def checkanswers_not_in_service?
-      service.checkanswers_page.blank?
+      @ordered.append([MetadataPresenter::Warning.new]) if show_warning?
     end
 
-    def confirmation_not_in_service?
-      service.confirmation_page.blank?
+    def checkanswers_warning
+      MetadataPresenter::PageWarning.new(
+        page: service.checkanswers_page,
+        main_flow_uuids: flow_uuids
+      )
     end
 
-    def cya_and_confirmation_pages_detached?
-      (checkanswers_detached? && confirmation_detached?) ||
-        checkanswers_detached? ||
-        confirmation_detached?
-    end
-
-    def checkanswers_detached?
-      if service.checkanswers_page.present?
-        uuid = service.checkanswers_page.uuid
-        position = coordinates.positions[uuid]
-        detached?(position)
-      end
-    end
-
-    def confirmation_detached?
-      if service.confirmation_page.present?
-        uuid = service.confirmation_page.uuid
-        position = coordinates.positions[uuid]
-        detached?(position)
-      end
+    def confirmation_warning
+      MetadataPresenter::PageWarning.new(
+        page: service.confirmation_page,
+        main_flow_uuids: flow_uuids
+      )
     end
 
     # Any destinations exiting the branch that have not already been traversed.

data/app/models/metadata_presenter/page_warning.rb

@@ -0,0 +1,24 @@
+module MetadataPresenter
+  class PageWarning
+    def initialize(page:, main_flow_uuids:)
+      @page = page
+      @main_flow_uuids = main_flow_uuids
+    end
+
+    def show_warning?
+      missing? || detached?
+    end
+
+    def missing?
+      page.blank?
+    end
+
+    def detached?
+      main_flow_uuids.exclude?(page&.uuid)
+    end
+
+    private
+
+    attr_reader :page, :main_flow_uuids
+  end
+end

data/app/models/metadata_presenter/row_number.rb

@@ -28,7 +28,7 @@ module MetadataPresenter
 
         return ROW_ZERO if place_on_row_zero?
 
-        existing_row || [current_row, potential_row].compact.max
+        existing_row || [current_row, potential_row, branch_spacer_row].compact.max
       end
     end
 
@@ -36,27 +36,60 @@ module MetadataPresenter
       @existing_row ||= coordinates.uuid_row(uuid)
     end
 
+    # This looks for any branches in the current column and checks that there is
+    # enough space for the any branch conditionals before returning a row number.
     def potential_row
       return if branches_in_column.empty?
 
-      row_numbers = branches_in_column.map do |uuid, _|
-        coordinates.branch_spacers[uuid].map { |position| position[:row] }
+      row_numbers = branches_in_column.map do |branch_uuid, _|
+        coordinates.branch_spacers[branch_uuid].map { |_, position| position[:row] }
       end
       row_numbers.flatten.max + 1
     end
 
+    # This looks at the previous column and finds any branches that link to the
+    # current object. If any are found it checks for rows numbers that relate
+    # to the current objects UUID in the branch spacers hash and defaults to
+    # returning the highest row number.
+    def branch_spacer_row
+      return if spacers_for_current_object.empty?
+
+      spacers_for_current_object.map { |position| position[:row] }.max
+    end
+
     def first_row?
       @first_row ||= route.row.zero?
     end
 
     def branches_in_column
-      @branches_in_column ||= coordinates.positions_in_column(uuid_column).select do |key, position|
+      @branches_in_column ||= branches(uuid_column)
+    end
+
+    def branches_in_previous_column
+      @branches_in_previous_column ||= branches(uuid_column - 1)
+    end
+
+    def branches(column_number)
+      coordinates.positions_in_column(column_number).select do |key, position|
         next if uuid == key || position[:row].blank?
 
         service.flow_object(key).branch?
       end
     end
 
+    def spacers_for_current_object
+      @spacers_for_current_object ||= begin
+        spacer_positions = branches_in_previous_column.select do |key, _|
+          coordinates.branch_spacers[key]
+        end
+
+        current_object_spacers = spacer_positions.map do |branch_uuid, _|
+          coordinates.branch_spacers[branch_uuid][uuid]
+        end
+        current_object_spacers.compact
+      end
+    end
+
     def uuid_column
       @uuid_column ||= coordinates.uuid_column(uuid)
     end

data/app/validators/metadata_presenter/email_validator.rb

@@ -0,0 +1,8 @@
+module MetadataPresenter
+  class EmailValidator < BaseValidator
+    def invalid_answer?
+      regex = URI::MailTo::EMAIL_REGEXP
+      user_answer.match(regex).nil?
+    end
+  end
+end

data/app/views/metadata_presenter/component/_email.html.erb

@@ -0,0 +1,11 @@
+<%=
+  f.govuk_email_field component.id.to_sym,
+    label: { text: input_title },
+    hint: {
+      data: { "fb-default-text" => default_text('hint') },
+      text: component.hint
+    },
+    name: "answers[#{component.name}]",
+    spellcheck: "false",
+    autocomplete: "email"
+%>

data/config/initializers/supported_components.rb

@@ -17,11 +17,11 @@ Rails.application.config.supported_components =
       content: %w(content)
     },
     multiplequestions: {
-      input: %w(text textarea number date radios checkboxes),
+      input: %w(text textarea number date radios checkboxes email),
       content: %w(content)
     },
     singlequestion: {
-      input: %w(text textarea number date radios checkboxes upload),
+      input: %w(text textarea number date radios checkboxes email upload),
       content: %w()
      }
   })

data/default_metadata/component/email.json

@@ -0,0 +1,12 @@
+{
+  "_id": "component.email",
+  "_type": "email",
+  "errors": {},
+  "label": "Question",
+  "hint": "",
+  "name": "component-name",
+  "validation": {
+    "email": true,
+    "required": true
+  }
+}

data/default_metadata/string/error.email.json

@@ -0,0 +1,6 @@
+{
+  "_id": "error.email",
+  "_type": "string.error",
+  "description": "Input (email) is not a valid email",
+  "value": "Enter an email address in the correct format, like name@example.com"
+}

data/fixtures/version.json

@@ -63,6 +63,12 @@
       }
     },
     "80420693-d6f2-4fce-a860-777ca774a6f5": {
+      "_type": "flow.page",
+      "next": {
+        "default": "adcb61c3-52b1-479b-be51-1bb610876d54"
+      }
+    },
+    "adcb61c3-52b1-479b-be51-1bb610876d54" : {
       "_type": "flow.page",
       "next": {
         "default": "2ef7d11e-0307-49e9-9fe2-345dc528dd66"
@@ -503,6 +509,31 @@
       "add_component": "content",
       "section_heading": "Chain of Command"
     },
+    {
+      "_id": "page.email",
+      "url": "email",
+      "body": "Body section",
+      "_type": "page.singlequestion",
+      "_uuid": "adcb61c3-52b1-479b-be51-1bb610876d54",
+      "heading": "Email",
+      "components": [
+        {
+          "_id": "email-address_email_1",
+          "hint": "",
+          "name": "email-address_email_1",
+          "_type": "email",
+          "_uuid": "482cb2d0-fda7-4e5c-9591-96dcb546e181",
+          "label": "Email address",
+          "errors": {},
+          "collection": "components",
+          "validation": {
+            "required": true,
+            "email": true,
+            "max_length": 256
+          }
+        }
+      ]
+    },
     {
       "_id": "page.dog-picture",
       "url": "dog-picture",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.14.0'.freeze
+  VERSION = '2.15.2'.freeze
 end

data/schemas/component/email.json

@@ -0,0 +1,23 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/email",
+  "_name": "component.email",
+  "title": "Email",
+  "description": "Let users enter an email address",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "email"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "http://gov.uk/schema/v1.0.0/definition/field"
+    },
+    {
+      "$ref": "http://gov.uk/schema/v1.0.0/definition/widthclass/input"
+    }
+  ],
+  "validation": {
+    "format": "email"
+  }
+}

data/schemas/component/text.json

@@ -13,9 +13,6 @@
     {
       "$ref": "definition.field"
     },
-    {
-      "$ref": "validations#/definitions/string_bundle"
-    },
     {
       "$ref": "definition.width_class.input"
     }

data/schemas/component/textarea.json

@@ -45,9 +45,6 @@
    {
       "$ref": "definition.field"
     },
-    {
-      "$ref": "validations#/definitions/string_bundle"
-    },
     {
       "$ref": "definition.width_class.input"
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.2
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -295,6 +295,7 @@ 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/page_warning.rb
 - app/models/metadata_presenter/previous_page.rb
 - app/models/metadata_presenter/route.rb
 - app/models/metadata_presenter/row_number.rb
@@ -311,6 +312,7 @@ files:
 - app/validators/metadata_presenter/accept_validator.rb
 - app/validators/metadata_presenter/base_validator.rb
 - app/validators/metadata_presenter/date_validator.rb
+- app/validators/metadata_presenter/email_validator.rb
 - app/validators/metadata_presenter/max_length_validator.rb
 - app/validators/metadata_presenter/max_size_validator.rb
 - app/validators/metadata_presenter/min_length_validator.rb
@@ -330,6 +332,7 @@ files:
 - app/views/metadata_presenter/component/_components.html.erb
 - app/views/metadata_presenter/component/_content.html.erb
 - app/views/metadata_presenter/component/_date.html.erb
+- app/views/metadata_presenter/component/_email.html.erb
 - app/views/metadata_presenter/component/_number.html.erb
 - app/views/metadata_presenter/component/_radios.html.erb
 - app/views/metadata_presenter/component/_text.html.erb
@@ -356,6 +359,7 @@ files:
 - default_metadata/component/checkboxes.json
 - default_metadata/component/content.json
 - default_metadata/component/date.json
+- default_metadata/component/email.json
 - default_metadata/component/number.json
 - default_metadata/component/radios.json
 - default_metadata/component/text.json
@@ -380,6 +384,7 @@ files:
 - default_metadata/service/base.json
 - default_metadata/string/error.accept.json
 - default_metadata/string/error.date.json
+- default_metadata/string/error.email.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.max_size.json
 - default_metadata/string/error.min_length.json
@@ -422,6 +427,7 @@ files:
 - schemas/component/checkboxes.json
 - schemas/component/content.json
 - schemas/component/date.json
+- schemas/component/email.json
 - schemas/component/number.json
 - schemas/component/radios.json
 - schemas/component/text.json
@@ -502,7 +508,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Service Metadata Presenter