metadata_presenter 1.3.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e53919bd4f689dd61ae84044e6cba77034053ddae502a61b7672310a917ea085
-  data.tar.gz: e6620c311a81a98f0a6fc6a40c5d1119449c54d56d79ff5b49f73a5855c8a4de
+  metadata.gz: '0817e0fd8648eed9b10a3b5244e6933f8492805f76843db92ae17f3fab3adf36'
+  data.tar.gz: a31749c039cd29a2c836959a47fb2801bb10418520f022edd6783cc78913a6c6
 SHA512:
-  metadata.gz: 7a49928da6f79c16e42e25af5a95330f1a9069ca1b37846b3a412e1bf33f2fe44da3971869bc583b4965e655836a8af684d2c88794547c0da66b6aa8ba0837b2
-  data.tar.gz: a28440a4e40e61a9caf08f2e3b7ac7f744b628d295a83d2ef9ca51465fc502f7b590839a06fd5af8ef823dc4a07f8ff191561767fa90d49c51a9720c8ff6a45a
+  metadata.gz: ad688abaf732349b401eabf92390c23db5760062d5b23bf36aca96431cfa3dfbbb2e7409ca2daf405828f4f65123225f1b3889ef014c20c121c333c6c23bf7ed
+  data.tar.gz: 31bd7f7e65d82476b75d6b6dc6d608b1ba30dab6e3b5b5c23b7ec539d08682ab0ed3a5ca278b5067f3550d6fd867551d3b8fb91fb2eaceda9f04787d2df86f4f

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

@@ -25,10 +25,12 @@ module MetadataPresenter
     end
 
     def redirect_to_next_page
-      next_page = NextPage.new(service).find(
+      next_page = NextPage.new(
+        service: service,
         session: session,
+        user_data: load_user_data,
         current_page_url: page_url
-      )
+      ).find
 
       if next_page.present?
         redirect_to_page next_page.url

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/component.rb

@@ -8,7 +8,7 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
   end
 
   def items
-    metadata.items.map do |item|
+    Array(metadata.items).map do |item|
       MetadataPresenter::Item.new(item, editor: editor?)
     end
   end
@@ -20,4 +20,8 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
   def upload?
     type == 'upload'
   end
+
+  def find_item_by_uuid(uuid)
+    items.find { |item| item.uuid == uuid }
+  end
 end

data/app/models/metadata_presenter/condition.rb

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,37 @@
+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/app/models/metadata_presenter/flow.rb

@@ -0,0 +1,21 @@
+module MetadataPresenter
+  class Flow < MetadataPresenter::Metadata
+    def branch?
+      type == 'branch'
+    end
+
+    def default_next
+      metadata['next']['default']
+    end
+
+    def conditions
+      Array(metadata['next']['conditions']).map do |condition_metadata|
+        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,18 +1,63 @@
 module MetadataPresenter
   class NextPage
-    attr_reader :service
+    include ActiveModel::Model
+    attr_accessor :service, :session, :user_data, :current_page_url
 
-    def initialize(service)
-      @service = service
-    end
+    def find
+      return check_answers_page if return_to_check_your_answer?
 
-    def find(session:, current_page_url:)
-      if session[:return_to_check_you_answer].present?
-        session[:return_to_check_you_answer] = nil
-        service.pages.find { |page| page.type == 'page.checkanswers' }
+      if conditions?
+        evaluate_conditions
+      elsif current_page_flow.present?
+        service.find_page_by_uuid(current_page_flow.default_next)
       else
         service.next_page(from: current_page_url)
       end
     end
+
+    private
+
+    def check_answers_page
+      session[:return_to_check_your_answer] = nil
+      service.pages.find { |page| page.type == 'page.checkanswers' }
+    end
+
+    def return_to_check_your_answer?
+      session[:return_to_check_your_answer].present?
+    end
+
+    def conditions?
+      current_page_flow.present? &&
+        next_flow.present? &&
+        next_flow_branch_object?
+    end
+
+    def evaluate_conditions
+      EvaluateConditions.new(
+        service: service,
+        flow: next_flow,
+        user_data: user_data
+      ).page
+    end
+
+    def current_page
+      service.find_page_by_url(current_page_url)
+    end
+
+    def current_page_uuid
+      current_page.uuid
+    end
+
+    def current_page_flow
+      service.flow(current_page_uuid)
+    end
+
+    def next_flow
+      service.flow(current_page_flow.default_next)
+    end
+
+    def next_flow_branch_object?
+      next_flow.branch?
+    end
   end
 end

data/app/models/metadata_presenter/page.rb

@@ -18,6 +18,10 @@ module MetadataPresenter
       to_h.reject { |k, _| k.in?(NOT_EDITABLE) }
     end
 
+    def find_component_by_uuid(uuid)
+      all_components.find { |component| component.uuid == uuid }
+    end
+
     def all_components
       [components, extra_components].flatten.compact
     end
@@ -58,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

@@ -27,6 +27,8 @@ 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]
       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

@@ -5,6 +5,12 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     end
   end
 
+  def flow(page_uuid)
+    MetadataPresenter::Flow.new(metadata.flow[page_uuid])
+  rescue StandardError
+    nil
+  end
+
   def standalone_pages
     @standalone_pages ||= metadata.standalone_pages.map do |page|
       MetadataPresenter::Page.new(page, editor: editor?)
@@ -33,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
@@ -48,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

@@ -0,0 +1,20 @@
+module MetadataPresenter
+  class BaseOperator
+    attr_reader :actual, :expected
+
+    def initialize(actual, expected)
+      @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