metadata_presenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5fb97a4c652ee76cd80c505b82660463ac5b430d501a77299c61e7721bfdf8e
+  data.tar.gz: 84fae72ad0d433dbc6e519e08ec108680832fb72d19f5a2c404d739c062c61d5
+SHA512:
+  metadata.gz: 92a7c904f51c6569e445b679796662426e3935f930d99a25bfaa9584a2b5da74444a6961ee0b104dfe8c9a4177a898b423ea3fd87db566b6e1c00d9ed0f84910
+  data.tar.gz: 1af429a8c6ef4e7b1d5d050d22e09bd247a48f5c63cf6afbcc01463555eedc2109867f5413639de32b80bc386bbc2e08e1b6c78c4658dc8d78b59f07302a0cbc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Tomas D'Stefano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# MetadataPresenter
+
+Rails engine responsible for rendering the MoJ Form Builder metadata into
+GOV.UK design system components.
+
+## Installation
+
+```ruby
+gem 'metadata_presenter'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install metadata_presenter
+```
+
+## Setup & Mount
+
+To mount the application:
+
+```ruby
+  mount MetadataPresenter::Engine => '/'
+```
+
+Or if you are using for another route (like the MoJ Editor as preview feature):
+
+```ruby
+  mount MetadataPresenter::Engine => '/preview', as: :preview
+```
+
+The MetadataPresenter controllers inherits from your main
+`::ApplicationController` as default but you can overwrite if you need:
+
+```ruby
+  MetadataPresenter.parent_controller = '::MyAwesomeController'
+```
+
+The application that you mount requires to save and load user data from some
+store (session or a backend API or direct to a database). In order to do
+that you need to write the following methods in your controller:
+
+1. save_user_data
+2. load_user_data
+
+The user answers can be accessed via `params[:answers]`.
+
+An example of implementation:
+```ruby
+ class MyAwesomeController
+   def save_user_data
+     session[:user_data] = params[:answers]
+   end
+
+   def load_user_data
+     session[:user_data]
+   end
+ end
+```
+
+## Generate documentation
+
+Run `rake doc` and open the doc/index.html

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MetadataPresenter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |yardoc|
+  yardoc.files = ['app/**/*.rb', 'lib/**/*.rb']
+end
+
+task default: :rspec
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+Bundler::GemHelper.install_tasks
+
+require 'bundler/gem_tasks'

data/app/assets/config/metadata_presenter_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/metadata_presenter .css

data/app/assets/stylesheets/metadata_presenter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/metadata_presenter/answers_controller.rb

@@ -0,0 +1,42 @@
+module MetadataPresenter
+  class AnswersController < EngineController
+    def create
+      if page.validate_answers(answers_params)
+        save_user_data # method signature
+        redirect_to_next_page
+      else
+        render_validation_error
+      end
+    end
+
+    private
+
+    def page
+      @page ||= MetadataPresenter::Page.new(
+        service.find_page(params[:page_url]).metadata
+      )
+    end
+
+    def redirect_to_next_page
+      next_page = NextPage.new(service).find(
+        session: session,
+        current_page_url: params[:page_url]
+      )
+
+      if next_page.present?
+        redirect_to_page next_page.url
+      else
+        not_found
+      end
+    end
+
+    def render_validation_error
+      @user_data = answers_params
+      render template: page.template, status: :unprocessable_entity
+    end
+
+    def answers_params
+      params[:answers] ? params[:answers].permit! : {}
+    end
+  end
+end

data/app/controllers/metadata_presenter/change_answer_controller.rb

@@ -0,0 +1,8 @@
+module MetadataPresenter
+  class ChangeAnswerController < EngineController
+    def create
+      session[:return_to_check_you_answer] = true
+      redirect_to_page params[:url]
+    end
+  end
+end

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -0,0 +1,25 @@
+module MetadataPresenter
+  class EngineController < MetadataPresenter.parent_controller.constantize
+    protect_from_forgery with: :exception
+
+    helper MetadataPresenter::ApplicationHelper
+    default_form_builder GOVUKDesignSystemFormBuilder::FormBuilder
+
+    def back_link
+      return if @page.blank?
+
+      @back_link ||= service.previous_page(current_page: @page)&.url
+    end
+    helper_method :back_link
+
+    private
+
+    def not_found
+      render template: 'errors/404', status: 404
+    end
+
+    def redirect_to_page(url)
+      redirect_to File.join(request.script_name, url)
+    end
+  end
+end

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -0,0 +1,14 @@
+module MetadataPresenter
+  class PagesController < EngineController
+    def show
+      @user_data = load_user_data # method signature
+      @page ||= service.find_page(request.env['PATH_INFO'])
+
+      if @page
+        render template: @page.template
+      else
+        not_found
+      end
+    end
+  end
+end

data/app/controllers/metadata_presenter/service_controller.rb

@@ -0,0 +1,8 @@
+module MetadataPresenter
+  class ServiceController < EngineController
+    def start
+      @page = service.start_page
+      render template: @page.template
+    end
+  end
+end

data/app/controllers/metadata_presenter/submissions_controller.rb

@@ -0,0 +1,13 @@
+module MetadataPresenter
+  class SubmissionsController < EngineController
+    def create
+      @page = service.confirmation_page
+
+      if @page
+        redirect_to_page @page.url
+      else
+        not_found
+      end
+    end
+  end
+end

data/app/helpers/metadata_presenter/application_helper.rb

@@ -0,0 +1,7 @@
+module MetadataPresenter
+  module ApplicationHelper
+    def to_markdown(text)
+      (Kramdown::Document.new(text).to_html).html_safe
+    end
+  end
+end

data/app/jobs/metadata_presenter/application_job.rb

@@ -0,0 +1,4 @@
+module MetadataPresenter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/metadata_presenter/component.rb

@@ -0,0 +1,5 @@
+class MetadataPresenter::Component < MetadataPresenter::Metadata
+  def to_partial_path
+    "component/#{type}"
+  end
+end

data/app/models/metadata_presenter/metadata.rb

@@ -0,0 +1,26 @@
+class MetadataPresenter::Metadata
+  include ActiveModel::Conversion
+  extend ActiveModel::Naming
+
+  attr_reader :metadata
+
+  def initialize(metadata)
+    @metadata = OpenStruct.new(metadata)
+  end
+
+  def id
+    metadata._id
+  end
+
+  def type
+    metadata._type
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    metadata.respond_to?(method_name)
+  end
+
+  def method_missing(method, *args, &block)
+    metadata.send(method, *args, &block)
+  end
+end

data/app/models/metadata_presenter/next_page.rb

@@ -0,0 +1,18 @@
+module MetadataPresenter
+  class NextPage
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+    end
+
+    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.summary' }
+      else
+        service.next_page(from: current_page_url)
+      end
+    end
+  end
+end

data/app/models/metadata_presenter/page.rb

@@ -0,0 +1,27 @@
+module MetadataPresenter
+  class Page < MetadataPresenter::Metadata
+    include ActiveModel::Validations
+
+    def validate_answers(answers)
+      ValidateAnswers.new(page: self, answers: answers).valid?
+    end
+
+    def ==(other)
+      id == other.id if other.respond_to? :id
+    end
+
+    def components
+      metadata.components&.map do |component|
+        MetadataPresenter::Component.new(component)
+      end
+    end
+
+    def to_partial_path
+      type.gsub('.', '/')
+    end
+
+    def template
+      "metadata_presenter/#{type.gsub('.', '/')}"
+    end
+  end
+end

data/app/models/metadata_presenter/service.rb

@@ -0,0 +1,28 @@
+class MetadataPresenter::Service < MetadataPresenter::Metadata
+  def pages
+    @_pages ||= metadata.pages.map { |page| MetadataPresenter::Page.new(page) }
+  end
+
+  def start_page
+    pages.first
+  end
+
+  def find_page(path)
+    pages.find { |page| page.url == path }
+  end
+
+  def next_page(from:)
+    current_page = find_page(from)
+    pages[pages.index(current_page) + 1] if current_page.present?
+  end
+
+  def previous_page(current_page:)
+    pages[pages.index(current_page) - 1] unless current_page == start_page
+  end
+
+  def confirmation_page
+    @confirmation_page ||= pages.find do |page|
+      page.type == 'page.confirmation'
+    end
+  end
+end

data/app/validators/metadata_presenter/base_validator.rb

@@ -0,0 +1,119 @@
+module MetadataPresenter
+  class NoDefaultMessage < StandardError; end
+
+  # Abstract base class for validation utilities.
+  # Provides an interface for implementing validation from the metadata.
+  #
+  # @abstract
+  #
+  # The Base validator expects the subclass to implement only #invalid_answer?
+  # as long the conventions are followed:
+  #
+  # 1. The default metadata for error messages follows the "error.name_of_the_class_without_validator"
+  # 2. The class should have the same name as the schema e.g 'required' will lookup for RequiredValidator.
+  #
+  # On the example below the base validator will look for the custom message
+  # on "errors" -> "grogu" -> "any" and if there is none, then will
+  # look for the default message on default metadata as "error.grogu".
+  #
+  # @example Custom validator
+  #   class GroguValidator < BaseValidator
+  #     def invalid_answer?
+  #       user_answer = answers[component.name]
+  #
+  #       user_answer.to_s == 'Grogu'
+  #     end
+  #   end
+  #
+  class BaseValidator
+    # @return [MetadataPresenter::Page] page object from the metadata
+    attr_reader :page
+
+    # @return [Hash] the user answers
+    attr_reader :answers
+
+    # @return [MetadataPresenter::Component] component object from the metadata
+    attr_reader :component
+
+    def initialize(page:, answers:, component:)
+      @page = page
+      @answers = answers
+      @component = component
+    end
+
+    def valid?
+      if invalid_answer?
+        error_message = custom_error_message || default_error_message
+        page.errors.add(component.id, error_message)
+      end
+
+      page.errors.blank?
+    end
+
+    # The custom message will be lookup from the schema key on the metadata.
+    # Assuming for example that the schema key is 'grogu' then the message
+    # will lookup for 'errors.grogu.any'.
+    #
+    # @return [String] message from the service metadata
+    #
+    def custom_error_message
+      message = component.dig('errors', schema_key, 'any')
+
+      message % error_message_hash if message.present?
+    end
+
+    # The default error message will be look using the schema key.
+    # Assuming the schema key is 'grogu' then the default message
+    # will look for 'error.grogu.value'.
+    #
+    # @return [String] returns the default error message
+    # @raise [MetadataPresenter::NoDefaultMessage] raises no default message if
+    # is not present
+    def default_error_message
+      default_error_message_key = "error.#{schema_key}"
+      default_message = Rails
+                          .application
+                          .config
+                          .default_metadata[default_error_message_key]
+
+      if default_message.present?
+        default_message['value'] % error_message_hash
+      else
+        raise NoDefaultMessage, "No default message found for key '#{default_error_message_key}'."
+      end
+    end
+
+    # Needs to be implemented on the subclass
+    #
+    # @return [TrueClass] if is invalid
+    # @return [FalseClass] if is valid
+    #
+    def invalid_answer?
+      raise NotImplementedError
+    end
+
+    # The convention to be looked on the metadata is by the name of the class.
+    # E.g the GroguValidator will look for 'grogu' on the metadata.
+    # Overwrite this method if the validator doesn't follow the convetions.
+    #
+    # @return [String] schema key to be looked on the metadata and in the
+    # default metadata
+    #
+    def schema_key
+      @schema_key ||= self.class.name.demodulize.gsub('Validator', '').underscore
+    end
+
+    # Error message hash that will be interpolate with the custom message or
+    # the default metadata
+    #
+    # The message could include '%{control}' to add the label name.
+    # Or for the GroguValidator will be '%{grogu}' and the value setup in the metadata.
+    #
+    def error_message_hash
+      {
+        control: component.label,
+        schema_key.to_sym => component.validation[schema_key]
+      }
+    end
+  end
+end