metadata_presenter 1.3.0 → 1.6.0

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/tasks/metadata_presenter_tasks.rake

@@ -1,4 +1,90 @@
-# 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
+    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
+          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.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-04 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
@@ -263,8 +277,12 @@ 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/date_field.rb
+- app/models/metadata_presenter/evaluate_conditions.rb
 - app/models/metadata_presenter/file_uploader.rb
+- app/models/metadata_presenter/flow.rb
 - app/models/metadata_presenter/item.rb
 - app/models/metadata_presenter/meta.rb
 - app/models/metadata_presenter/meta_item.rb
@@ -273,8 +291,16 @@ 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
+- app/operators/metadata_presenter/is_not_answered_operator.rb
+- app/operators/metadata_presenter/is_not_operator.rb
+- app/operators/metadata_presenter/is_operator.rb
+- app/operators/metadata_presenter/operator.rb
 - app/presenters/metadata_presenter/page_answers_presenter.rb
 - app/validators/metadata_presenter/accept_validator.rb
 - app/validators/metadata_presenter/base_validator.rb
@@ -316,6 +342,7 @@ files:
 - app/views/metadata_presenter/page/start.html.erb
 - config/initializers/default_metadata.rb
 - config/initializers/default_text.rb
+- config/initializers/inflections.rb
 - config/initializers/page_components.rb
 - config/initializers/schemas.rb
 - config/routes.rb
@@ -348,6 +375,7 @@ files:
 - default_metadata/string/error.required.json
 - default_metadata/string/error.virus_scan.json
 - default_text/content.json
+- fixtures/branching.json
 - fixtures/invalid_content_page.json
 - fixtures/no_component_page.json
 - fixtures/non_finished_service.json