metadata_presenter 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c6331901af4f170f3090b864ee079ab1eb823767d0945028f7a0d55a1171ff
-  data.tar.gz: 5aa7f0ec508ca49be80ebec1cc4dabf1b9875a254aef8df142afacf77a84a951
+  metadata.gz: 10a6602fbd7108b4fe94aa7d3dd4037236d051701bc7b9b41b73d5af5598c506
+  data.tar.gz: e0802516349bf5827a653d756f14c70e827bb7ec7e8a6bfbe6d321bfb565387a
 SHA512:
-  metadata.gz: 27f712d97eb70864b053af2461c4be20176adccb40b59ef8ccb0fb1743b32e390535df4814cf4a973724a8d4b4d7b970bf84c22798a09f77257b6dff8d8a4ceb
-  data.tar.gz: 8174c567a25e82ff3d46f50b6ba3e64c6fe946cd21a2716e90419d1a535410e9fadaba0fd342e908d787c6dafbbd28fb6a79a93130a8d2a71494d01859eec4a0
+  metadata.gz: 75c775d98418d5b1b52a07210b51b95bc122c191b261bd0c8a8b195768747cc60ad6282d14d770ca11f45eeaa36108c7aa22bd59b24dfb30614fcd012db09a8b
+  data.tar.gz: 71166dba57d1a2362d60583c57da0bbf7d145fd2f6e338dedf15124d74af3f47c215e72063b3efce5163075b71c33f646c5d94e93a3525dd83c4ae3732b31530

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,8 +6,8 @@ module MetadataPresenter
     def find
       return check_answers_page if return_to_check_your_answer?
 
-      if conditions?
-        evaluate_conditions
+      if conditionals?
+        evaluate_conditionals
       elsif current_page_flow.present?
         service.find_page_by_uuid(current_page_flow.default_next)
       else
@@ -26,14 +26,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/traversed_pages.rb

@@ -22,7 +22,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/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '1.9.0'.freeze
+  VERSION = '2.0.0'.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.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-07-14 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

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": []
-}