RubyGems - metadata_presenter - Versions diffs - 0.1.0 - Mend

metadata_presenter 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +68 -0
data/Rakefile +29 -0
data/app/assets/config/metadata_presenter_manifest.js +1 -0
data/app/assets/stylesheets/metadata_presenter/application.css +15 -0
data/app/controllers/metadata_presenter/answers_controller.rb +42 -0
data/app/controllers/metadata_presenter/change_answer_controller.rb +8 -0
data/app/controllers/metadata_presenter/engine_controller.rb +25 -0
data/app/controllers/metadata_presenter/pages_controller.rb +14 -0
data/app/controllers/metadata_presenter/service_controller.rb +8 -0
data/app/controllers/metadata_presenter/submissions_controller.rb +13 -0
data/app/helpers/metadata_presenter/application_helper.rb +7 -0
data/app/jobs/metadata_presenter/application_job.rb +4 -0
data/app/models/metadata_presenter/component.rb +5 -0
data/app/models/metadata_presenter/metadata.rb +26 -0
data/app/models/metadata_presenter/next_page.rb +18 -0
data/app/models/metadata_presenter/page.rb +27 -0
data/app/models/metadata_presenter/service.rb +28 -0
data/app/validators/metadata_presenter/base_validator.rb +119 -0
data/app/validators/metadata_presenter/max_length_validator.rb +7 -0
data/app/validators/metadata_presenter/min_length_validator.rb +7 -0
data/app/validators/metadata_presenter/required_validator.rb +7 -0
data/app/validators/metadata_presenter/validate_answers.rb +48 -0
data/app/validators/metadata_presenter/validate_schema.rb +39 -0
data/app/views/errors/404.html +67 -0
data/app/views/layouts/metadata_presenter/application.html.erb +33 -0
data/app/views/metadata_presenter/component/_text.html.erb +7 -0
data/app/views/metadata_presenter/header/show.html.erb +35 -0
data/app/views/metadata_presenter/page/confirmation.html.erb +21 -0
data/app/views/metadata_presenter/page/form.html.erb +19 -0
data/app/views/metadata_presenter/page/singlequestion.html.erb +18 -0
data/app/views/metadata_presenter/page/start.html.erb +38 -0
data/app/views/metadata_presenter/page/summary.html.erb +73 -0
data/config/initializers/default_metadata.rb +15 -0
data/config/initializers/schemas.rb +13 -0
data/config/routes.rb +8 -0
data/lib/metadata_presenter.rb +4 -0
data/lib/metadata_presenter/engine.rb +9 -0
data/lib/metadata_presenter/version.rb +3 -0
data/lib/tasks/metadata_presenter_tasks.rake +4 -0
metadata +285 -0

data/app/validators/metadata_presenter/max_length_validator.rb ADDED

@@ -0,0 +1,7 @@
+module MetadataPresenter
+  class MaxLengthValidator < BaseValidator
+    def invalid_answer?
+      answers[component.name].to_s.size > component.validation[schema_key]
+    end
+  end
+end

data/app/validators/metadata_presenter/min_length_validator.rb ADDED

@@ -0,0 +1,7 @@
+module MetadataPresenter
+  class MinLengthValidator < BaseValidator
+    def invalid_answer?
+      answers[component.name].to_s.size < component.validation[schema_key]
+    end
+  end
+end

data/app/validators/metadata_presenter/required_validator.rb ADDED

@@ -0,0 +1,7 @@
+module MetadataPresenter
+  class RequiredValidator < BaseValidator
+    def invalid_answer?
+      answers[component.name].blank?
+    end
+  end
+end

data/app/validators/metadata_presenter/validate_answers.rb ADDED

@@ -0,0 +1,48 @@
+module MetadataPresenter
+  class ValidateAnswers
+    attr_reader :page, :components, :answers
+    def initialize(page:, answers:)
+      @page = page
+      @answers = answers
+      @components = Array(page.components)
+    end
+    def valid?
+      validators.map { |validator| validator.valid? }.all?
+    end
+    def invalid?
+      !valid?
+    end
+    def validators
+      components.map do |component|
+        component_validations(component).map do |key|
+          "MetadataPresenter::#{key.classify}Validator".constantize.new(
+            page: page,
+            answers: answers,
+            component: component
+          )
+        end
+      end.compact.flatten
+    end
+    def component_validations(component)
+      return [] if component.validation.blank?
+      component.validation.reject do |_, value|
+        value.blank? ||
+        (optional_question?(component) && question_not_answered?)
+      end.keys
+    end
+    def optional_question?(component)
+      component.validation['required'] == false
+    end
+    def question_not_answered?
+      answers.values.any?(&:blank?)
+    end
+  end
+end

data/app/validators/metadata_presenter/validate_schema.rb ADDED

@@ -0,0 +1,39 @@
+class SchemaNotFoundError < StandardError
+end
+class MetadataPresenter::ValidateSchema
+  class << self
+    def before(controller)
+      return unless controller.request.post?
+      schema_name = "request.#{controller.request.params['controller']}"
+      validate(controller.request.params, schema_name)
+    rescue JSON::Schema::ValidationError, JSON::Schema::SchemaError, SchemaNotFoundError => e
+      controller.render(
+        json: ErrorsSerializer.new(message: e.message).attributes,
+        status: :unprocessable_entity
+      )
+    end
+    def validate(metadata, schema_name)
+      schema = JSON::Validator.schema_for_uri(schema_name)&.schema || find(schema_name)
+      JSON::Validator.validate!(schema, metadata)
+    end
+    def find(schema_name)
+      schema_file = schema_name.gsub('.', '/')
+      schema = JSON.parse(
+        File.read(
+          File.join(
+            Rails.application.config.schemas_directory, "#{schema_file}.json"
+          )
+        )
+      )
+      jschema = JSON::Schema.new(schema, Addressable::URI.parse(schema['_name']))
+      JSON::Validator.add_schema(jschema)
+      JSON::Validator.schema_for_uri(schema_name).schema
+    rescue Errno::ENOENT
+      raise SchemaNotFoundError.new("Schema not found => #{schema_name}")
+    end
+  end
+end

data/app/views/errors/404.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/app/views/layouts/metadata_presenter/application.html.erb ADDED

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= service.service_name %></title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+  <link rel="shortcut icon" sizes="16x16 32x32 48x48" href="<%= asset_pack_url('media/images/favicon.ico') %>" type="image/x-icon" />
+  <link rel="mask-icon" href="<%= asset_pack_url('media/images/govuk-mask-icon.svg') %>" color="blue">
+  <link rel="apple-touch-icon" sizes="180x180" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon-180x180.png') %>">
+  <link rel="apple-touch-icon" sizes="167x167" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon-167x167.png') %>">
+  <link rel="apple-touch-icon" sizes="152x152" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon-152x152.png') %>">
+  <link rel="apple-touch-icon" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon.png') %>">
+    <%= stylesheet_pack_tag 'govuk' %>
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+    <%= javascript_pack_tag 'application' %>
+  </head>
+  <body class="govuk-template__body">
+    <%= render template: 'metadata_presenter/header/show' %>
+    <div class="govuk-width-container govuk-body-m">
+      <main class="govuk-main-wrapper govuk-main-wrapper--auto-spacing" id="main-content" role="main">
+      <% if back_link.present? %>
+        <a class="govuk-back-link" href="<%= back_link %>">Back</a>
+      <% end %>
+        <%= yield %>
+      </main>
+    </div>
+    <%= javascript_pack_tag 'govuk' %>
+  </body>
+</html>

data/app/views/metadata_presenter/component/_text.html.erb ADDED

@@ -0,0 +1,7 @@
+<%=
+  f.govuk_text_field component.id.to_sym,
+    label: { text: component.label },
+    hint: { text: component.hint },
+    name: "answers[#{component.name}]",
+    value: @user_data[component.name]
+%>

data/app/views/metadata_presenter/header/show.html.erb ADDED

@@ -0,0 +1,35 @@
+<header class="govuk-header" role="banner" data-module="govuk-header">
+  <div class="govuk-header__container govuk-width-container">
+    <div class="govuk-header__logo">
+      <a href="/" class="govuk-header__link govuk-header__link--homepage">
+        <span class="govuk-header__logotype">
+          <svg
+            aria-hidden="true"
+            focusable="false"
+            class="govuk-header__logotype-crown"
+            xmlns="http://www.w3.org/2000/svg"
+            viewbox="0 0 132 97"
+            height="30"
+            width="36"
+          >
+            <path
+              fill="currentColor" fill-rule="evenodd"
+              d="M25 30.2c3.5 1.5 7.7-.2 9.1-3.7 1.5-3.6-.2-7.8-3.9-9.2-3.6-1.4-7.6.3-9.1 3.9-1.4 3.5.3 7.5 3.9 9zM9 39.5c3.6 1.5 7.8-.2 9.2-3.7 1.5-3.6-.2-7.8-3.9-9.1-3.6-1.5-7.6.2-9.1 3.8-1.4 3.5.3 7.5 3.8 9zM4.4 57.2c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.5-1.5-7.6.3-9.1 3.8-1.4 3.5.3 7.6 3.9 9.1zm38.3-21.4c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.6-1.5-7.6.3-9.1 3.8-1.3 3.6.4 7.7 3.9 9.1zm64.4-5.6c-3.6 1.5-7.8-.2-9.1-3.7-1.5-3.6.2-7.8 3.8-9.2 3.6-1.4 7.7.3 9.2 3.9 1.3 3.5-.4 7.5-3.9 9zm15.9 9.3c-3.6 1.5-7.7-.2-9.1-3.7-1.5-3.6.2-7.8 3.7-9.1 3.6-1.5 7.7.2 9.2 3.8 1.5 3.5-.3 7.5-3.8 9zm4.7 17.7c-3.6 1.5-7.8-.2-9.2-3.8-1.5-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.3 3.5-.4 7.6-3.9 9.1zM89.3 35.8c-3.6 1.5-7.8-.2-9.2-3.8-1.4-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.4 3.6-.3 7.7-3.9 9.1zM69.7 17.7l8.9 4.7V9.3l-8.9 2.8c-.2-.3-.5-.6-.9-.9L72.4 0H59.6l3.5 11.2c-.3.3-.6.5-.9.9l-8.8-2.8v13.1l8.8-4.7c.3.3.6.7.9.9l-5 15.4v.1c-.2.8-.4 1.6-.4 2.4 0 4.1 3.1 7.5 7 8.1h.2c.3 0 .7.1 1 .1.4 0 .7 0 1-.1h.2c4-.6 7.1-4.1 7.1-8.1 0-.8-.1-1.7-.4-2.4V34l-5.1-15.4c.4-.2.7-.6 1-.9zM66 92.8c16.9 0 32.8 1.1 47.1 3.2 4-16.9 8.9-26.7 14-33.5l-9.6-3.4c1 4.9 1.1 7.2 0 10.2-1.5-1.4-3-4.3-4.2-8.7L108.6 76c2.8-2 5-3.2 7.5-3.3-4.4 9.4-10 11.9-13.6 11.2-4.3-.8-6.3-4.6-5.6-7.9 1-4.7 5.7-5.9 8-.5 4.3-8.7-3-11.4-7.6-8.8 7.1-7.2 7.9-13.5 2.1-21.1-8 6.1-8.1 12.3-4.5 20.8-4.7-5.4-12.1-2.5-9.5 6.2 3.4-5.2 7.9-2 7.2 3.1-.6 4.3-6.4 7.8-13.5 7.2-10.3-.9-10.9-8-11.2-13.8 2.5-.5 7.1 1.8 11 7.3L80.2 60c-4.1 4.4-8 5.3-12.3 5.4 1.4-4.4 8-11.6 8-11.6H55.5s6.4 7.2 7.9 11.6c-4.2-.1-8-1-12.3-5.4l1.4 16.4c3.9-5.5 8.5-7.7 10.9-7.3-.3 5.8-.9 12.8-11.1 13.8-7.2.6-12.9-2.9-13.5-7.2-.7-5 3.8-8.3 7.1-3.1 2.7-8.7-4.6-11.6-9.4-6.2 3.7-8.5 3.6-14.7-4.6-20.8-5.8 7.6-5 13.9 2.2 21.1-4.7-2.6-11.9.1-7.7 8.8 2.3-5.5 7.1-4.2 8.1.5.7 3.3-1.3 7.1-5.7 7.9-3.5.7-9-1.8-13.5-11.2 2.5.1 4.7 1.3 7.5 3.3l-4.7-15.4c-1.2 4.4-2.7 7.2-4.3 8.7-1.1-3-.9-5.3 0-10.2l-9.5 3.4c5 6.9 9.9 16.7 14 33.5 14.8-2.1 30.8-3.2 47.7-3.2z"
+            ></path>
+            <image src="{{ params.assetsPath | default('/assets/images') }}/govuk-logotype-crown.png" xlink:href="" class="govuk-header__logotype-crown-fallback-image" width="36" height="32"></image>
+          </svg>
+          <span class="govuk-header__logotype-text">
+            GOV.UK
+          </span>
+        </span>
+      </a>
+    </div>
+    <% if service.service_name.present? %>
+      <div class="govuk-header__content">
+        <a href="/" class="govuk-header__link govuk-header__link--service-name">
+          <%= service.service_name %>
+        </a>
+    <% end %>
+    </div>
+  </div>
+</header>

data/app/views/metadata_presenter/page/confirmation.html.erb ADDED

@@ -0,0 +1,21 @@
+<div class="govuk-panel govuk-panel--confirmation" data-block-id="<%= @page.id %>" data-block-property="heading" data-block-property-class="govuk-panel__body:lede">
+  <h1 class="govuk-panel__title">
+    <%= @page.heading %>
+  </h1>
+  <% if @page.lede %>
+    <div class="govuk-panel__body">
+      <p><%= @page.lede %></p>
+    </div>
+  <% end %>
+</div>
+<% if @page.body %>
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <div class="fb-body govuk-prose-scope" data-block-id="<%= @page.id %>" data-block-property="body">
+        <%= @page.body %>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/metadata_presenter/page/form.html.erb ADDED

@@ -0,0 +1,19 @@
+<div class="fb-main-grid-wrapper" data-block-id="<%= @page.id %>" data-block-type="page" data-block-pagetype="<%= @page.type %>">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <% if @page.body %>
+        <p class="govuk-body-l" data-block-id="<%= @page.id %>" data-block-property="lede">
+        <%= to_markdown(@page.body) %>
+        </p>
+      <%- end %>
+       <%= form_tag(reserved_answers_path, method: :post) do  %>
+        <button class='govuk-button govuk-button--start govuk-!-margin-top-2'>
+        Continue
+          <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" aria-hidden="true" focusable="false">
+            <path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z" />
+          </svg>
+        </button>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/page/singlequestion.html.erb ADDED

@@ -0,0 +1,18 @@
+<div class="fb-main-grid-wrapper" data-block-id="<%= @page.id %>" data-block-type="page" data-block-pagetype="<%= @page.type %>">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <h1 class="<%= @page.heading_class %>" data-block-id="<%= @page.id %>" data-block-property="heading">
+          <%= @page.heading.html_safe %>
+      </h1>
+      <%= form_for @page, url: reserved_answers_path(@page.url) do |f| %>
+        <%= f.govuk_error_summary %>
+        <% @page.components.each do |component| %>
+          <%= render partial: component, locals: { component: component, f: f } %>
+        <% end %>
+        <%= f.govuk_submit %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/page/start.html.erb ADDED

@@ -0,0 +1,38 @@
+<div class="fb-main-grid-wrapper" data-block-id="<%= @page.id %>" data-block-type="page" data-block-pagetype="<%= @page.type %>">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <% if @page.section_heading -%>
+        <p class="govuk-caption-l fb-section_heading" data-block-id="<%= @page.id %>" data-block-property="section_heading">
+          <%= @page.section_heading.html_safe %>
+        </p>
+      <%- end %>
+      <% if @page.heading %>
+        <h1 class="<%= @page.heading_class %>" data-block-id="<%= @page.id %>" data-block-property="heading">
+          <%= @page.heading.html_safe %>
+        </h1>
+      <% end %>
+      <% if @page.lede %>
+        <p class="govuk-body-l" data-block-id="<%= @page.id %>" data-block-property="lede">
+          <%= @page.lede.html_safe %>
+        </p>
+      <%- end %>
+      <% if @page.body %>
+        <p class="govuk-body-l" data-block-id="<%= @page.id %>" data-block-property="lede">
+        <%= to_markdown(@page.body) %>
+        </p>
+      <%- end %>
+      <%= form_tag(reserved_answers_path(@page.url), method: :post) do %>
+        <button class='govuk-button govuk-button--start govuk-!-margin-top-2'>
+        Start
+          <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" aria-hidden="true" focusable="false">
+            <path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z" />
+          </svg>
+        </button>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/page/summary.html.erb ADDED

@@ -0,0 +1,73 @@
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <% if @page.section_heading.present? %>
+      <p class="govuk-caption-l fb-section-heading" data-block-id="<%= @page.id %>" data-block-property="section_heading">
+        <%= @page.section_heading %>
+      </p>
+    <% end %>
+    <% if @page.heading.present? %>
+      <h1 class="govuk-heading-xl" data-block-id="<%= @page.id %>" data-block-property="heading">
+        <%= @page.heading %>
+      </h1>
+    <% end %>
+    <% if @page.lede.present? %>
+      <p class="govuk-body-l" data-block-id="<%= @page.id %>" data-block-property="lede">
+        <%= @page.lede %>
+      </p>
+    <% end %>
+    <% if @page.body.present? %>
+      <div class="fb-body govuk-prose-scope" data-block-id="<%= @page.id %>" data-block-property="body">
+        <p><%= @page.body %></p>
+      </div>
+    <% end %>
+    <%= form_for @page, url: reserved_submissions_path do |f| %>
+      <div data-block-id="page.summary.answers" data-block-type="answers">
+        <dl class="fb-block fb-block-answers govuk-summary-list">
+          <% @service.pages.each do |page| %>
+            <% Array(page.components).each do |component| %>
+              <div class="govuk-summary-list__row">
+                <dt class="govuk-summary-list__key">
+                  <%= component.label %>
+                </dt>
+                <dd class="govuk-summary-list__value">
+                  <%= @user_data[component.name] %>
+                </dd>
+                <dd class="govuk-summary-list__actions">
+                <%= link_to(change_answer_path(url: page.url),
+                       class: 'govuk-link',
+                       method: :post) do %>
+                       Change<span class="govuk-visually-hidden"> Your answer for <%= component.label %></span>
+                  <% end %>
+                  </a>
+                </dd>
+              </div>
+            <% end %>
+          <% end %>
+        </dl>
+      </div>
+      <% if @page.send_heading.present? %>
+        <h2 class="fb-send-heading govuk-heading-m" data-block-id="<%= @page.id %>" data-block-property="send_heading">
+          <%= @page.send_heading %>
+        </h2>
+      <% end %>
+      <% if @page.send_body.present? %>
+        <div class="fb-send-body" data-block-id="<%= @page.id %>" data-block-property="send_body">
+          <p>
+            <%= @page.send_body %>
+          </p>
+        </div>
+      <% end %>
+      <button data-prevent-double-click="true" class="fb-block fb-block-actions govuk-button" data-module="govuk-button" data-block-id="actions" data-block-type="actions">
+        Accept and send application
+      </button>
+    <% end %>
+  </div>
+</div>

data/config/initializers/default_metadata.rb ADDED

@@ -0,0 +1,15 @@
+Rails.application.config.default_metadata_directory = MetadataPresenter::Engine.root.join('default_metadata')
+Rails.application.config.default_metadata = {}
+Rails.logger.info('Loading default metadata')
+default_metadata = Dir.glob("#{Rails.application.config.default_metadata_directory}/*/**")
+default_metadata.each do |metadata_file|
+  metadata = JSON.parse(File.read(metadata_file))
+  Rails.logger.info(metadata['_id'])
+  Rails.application.config.default_metadata[metadata['_id']] = metadata
+end
+Rails.logger.info(
+  "Total loaded default metadata => #{Rails.application.config.default_metadata.count}"
+)