ama_layout 5.12.0 → 6.3.0.pre

data/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +0,0 @@
-### PR Review Checklist
-To be completed by the person who opens the PR. Use strikethroughs for items that are not applicable in list.
-- [ ] I have reviewed my own PR to check syntax & logic, removed unnecessary/old code, made sure everything aligns with our style guide and BEM.
-- [ ] I've added new components to the style guide (or have a PR in to add them).
-- [ ] Any applicable version numbers have been updated.
-- [ ] I've tested on mobile, tablet, and desktop, as well as across all of the browsers we support.
-- [ ] I've proof-read all text for legibility, proper grammar, punctuation, and capitalization (titlecase).
-- [ ] I have written a detailed PR message explaining what is being changed and why
-- [ ] I’ve linked to any relevant VSTS tickets
-- [ ] I’ve added the appropriate review symbols to my PR - (elephant) for dev review, (art) for design

data/app/assets/javascripts/ama_layout/notifications.coffee

@@ -1,17 +0,0 @@
-class AMALayout.Notifications
-  constructor: () ->
-    $(document).on 'click', '[data-notifications-toggle]', (event) =>
-      event.preventDefault();
-      badge = event.currentTarget
-      if $(badge).find('[data-notification-count]').remove().size()
-        @request()
-
-  request: () ->
-    $.ajax(
-      type: 'DELETE',
-      url: '/ama_layout/api/v1/notifications',
-      timeout: 10000
-    )
-
-$(document).ready ->
-  window.AMALayout.notifications = new AMALayout.Notifications()

data/app/controllers/ama_layout/api/v1/notifications_controller.rb

@@ -1,18 +0,0 @@
-module AmaLayout
-  module Api
-    module V1
-      class NotificationsController < ApplicationController
-        before_action :require_login
-
-        # DELETE /api/v1/notifications
-        # Dismiss all user notifications
-        def dismiss_all
-          notifications = current_user.notifications
-          notifications.each(&:dismiss!)
-          notifications.save
-          head :no_content
-        end
-      end
-    end
-  end
-end

data/app/views/ama_layout/_notification.html.erb

@@ -1,10 +0,0 @@
-<div class="row <%= notification.active_class %>">
-  <div class="small-2 column">
-    <%= notification.icon %>
-  </div>
-  <div class="small-10 column">
-    <p class="bold"><%= notification.header %></p>
-    <p><%= sanitize notification.content, scrubber: AmaLayout::NotificationScrubber.new %></p>
-    <p class="micetype"><%= notification.created_at %></p>
-  </div>
-</div>

data/app/views/ama_layout/_notification_sidebar.html.erb

@@ -1,22 +0,0 @@
-<div class="off-canvas position-right right-sidebar" id="offCanvasRight" data-off-canvas>
-  <div class="row column right-sidebar__header">
-    <h2 class="mt1">Notification Centre</h2>
-    <button class="close-button" aria-label="Close menu" type="button" data-close>
-      <span aria-hidden="true">&times;</span>
-    </button>
-  </div>
-  <div class="row column">
-    <%= navigation.notifications_heading %>
-  </div>
-  <%= render partial: 'ama_layout/notification', collection: notifications %>
-  <div class="row column">
-    <p class="mt1">Did You Know?</p>
-    <div class="section-content">
-      <p class="bold">Sign up for Vehicle Registration Auto-Renew</p>
-      <p>
-        We'll process your payment and mail you a new registration certificate and licence plate sticker. It's that simple!
-      </p>
-      <%= link_to 'Sign up now', "#{Rails.configuration.registries_site}/order/registrations/new", class: 'button--right button--expand-small-down' %>
-    </div>
-  </div>
-</div>

data/app/views/ama_layout/_notifications.html.erb

@@ -1,6 +0,0 @@
-<li>
-  <a href="#" class="notification link--no-underline" data-toggle="offCanvasRight" data-notifications-toggle>
-    <i class="fa fa-2x fa-bell"></i>
-    <%= navigation.notification_badge %>
-  </a>
-</li>

data/app/views/ama_layout/_sign_out_link.html.erb

@@ -1,3 +0,0 @@
-<li class="side-nav__item">
-  <a class="side-nav__link" href="/logout">Sign Out</a>
-</li>

data/config/routes.rb

@@ -1,9 +0,0 @@
-AmaLayout::Engine.routes.draw do
-  scope module: 'ama_layout' do
-    namespace :api do
-      namespace :v1 do
-        delete :notifications, to: 'notifications#dismiss_all'
-      end
-    end
-  end
-end

data/lib/ama_layout/decorators/notification_decorator.rb

@@ -1,46 +0,0 @@
-module AmaLayout
-  class NotificationDecorator
-    include AmaLayout::DraperReplacement
-    extend AmaLayout::DraperReplacement
-
-    ICONS = {
-      notice: {
-        icon_class: 'fa-info',
-        colour_class: 'right-sidebar__content-icon--blue' # currently not in use
-      },
-      warning: {
-        icon_class: 'fa-exclamation',
-        colour_class: 'right-sidebar__content-icon--orange'
-      },
-      alert: {
-        icon_class: 'fa-exclamation-triangle',
-        colour_class: 'right-sidebar__content-icon--red'
-      }
-    }.freeze
-
-    def created_at
-      "#{time_elapsed} ago".humanize
-    end
-
-    def icon
-      h.content_tag :div, class: icon_data.fetch(:colour_class) do
-        klass = icon_data.fetch(:icon_class)
-        h.content_tag :i, nil, class: "fa #{klass} right-sidebar__notice-icon"
-      end
-    end
-
-    def active_class
-      active? ? 'right-sidebar__content--active' : 'right-sidebar__content--inactive'
-    end
-
-    private
-
-    def icon_data
-      @icon_data ||= ICONS.fetch(type)
-    end
-
-    def time_elapsed
-      h.time_ago_in_words(object.created_at, include_seconds: true)
-    end
-  end
-end

data/lib/ama_layout/draper_replacement.rb

@@ -1,27 +0,0 @@
-module AmaLayout
-  module DraperReplacement
-    attr_accessor :object
-
-    def h
-      ActionView::Base.new(::ActionController::Base.view_paths, {}, ::ApplicationController.new)
-    end
-
-    def initialize(args = {})
-      self.object = args
-    end
-
-    def self.decorate_collection(objects = {})
-      objects.map { |o| self.new(o) }
-    end
-
-    def method_missing(method, *args, &block)
-      return super unless delegatable?(method)
-
-      (object || DraperReplacement).send(method, *args, &block)
-    end
-
-    def delegatable?(method)
-      object.respond_to?(method) || DraperReplacement.respond_to?(method)
-    end
-  end
-end

data/lib/ama_layout/navigation_helper.rb

@@ -1,31 +0,0 @@
-module AmaLayout
-  module NavigationHelper
-    def navigation
-      return AmaLayout::Navigation.non_member unless member?
-      case
-      when _has_outstanding_balance?
-        AmaLayout::Navigation.member_with_outstanding_balance
-      when _in_renewal_late?
-        AmaLayout::Navigation.member_in_renewal_late
-      when _in_renewal?
-        AmaLayout::Navigation.member_in_renewal
-      else
-        AmaLayout::Navigation.member
-      end
-    end
-
-    private
-
-    def _in_renewal?
-      in_renewal
-    end
-
-    def _in_renewal_late?
-      status == "AL"
-    end
-
-    def _has_outstanding_balance?
-      has_outstanding_balance
-    end
-  end
-end

data/lib/ama_layout/notification.rb

@@ -1,87 +0,0 @@
-module AmaLayout
-  class Notification
-    TYPES = %i[notice warning alert].freeze
-    DEFAULT_LIFESPAN = 1.year.freeze
-    FORMAT_VERSION = '1.0.0'.freeze
-
-    # NOTE: The following attributes are designed to be immutable - you need
-    # make a new instance to change them. The only mutable attribute is :active.
-    attr_reader :id, :type, :brand, :header, :content, :created_at, :lifespan,
-                :version
-    attr_accessor :active
-
-    def initialize(args = {})
-      args = args.with_indifferent_access
-      @id = args[:id]
-      @type = args.fetch(:type, :notice).to_sym
-      @brand = args[:brand]
-      @header = args.fetch(:header)
-      @content = args.fetch(:content)
-      @created_at = parse_time(args.fetch(:created_at))
-      @lifespan = parse_duration(args.fetch(:lifespan, DEFAULT_LIFESPAN))
-      @version = args.fetch(:version, FORMAT_VERSION)
-      self.active = args.fetch(:active)
-      invalid_type! if TYPES.exclude?(type)
-    end
-
-    def <=>(other)
-      created_at <=> other.created_at
-    end
-
-    def active?
-      active
-    end
-
-    def dismissed?
-      !active?
-    end
-
-    def dismiss!
-      self.active = false
-      dismissed?
-    end
-
-    def digest
-      Digest::SHA256.hexdigest(
-        "#{type}#{header}#{content}#{brand}#{version}"
-      )
-    end
-
-    def stale?
-      Time.current > created_at + lifespan
-    end
-
-    def to_h
-      # NOTE: We want the following keys to be strings to provide
-      # consistency with the underlying data store.
-      {
-        'type' => type.to_s,
-        'brand' => brand,
-        'header' => header,
-        'content' => content,
-        'created_at' => created_at.iso8601,
-        'active' => active,
-        'lifespan' => lifespan.to_i,
-        'version' => version
-      }
-    end
-
-    private
-
-    def invalid_type!
-      raise ArgumentError, "invalid notification type: #{type}"
-    end
-
-    def parse_time(time)
-      time.is_a?(String) ? Time.zone.parse(time) : time
-    end
-
-    def parse_duration(duration)
-      if duration.is_a?(ActiveSupport::Duration)
-        duration
-      else
-        duration.seconds
-      end
-    end
-  end
-end

data/lib/ama_layout/notification_scrubber.rb

@@ -1,13 +0,0 @@
-module AmaLayout
-  class NotificationScrubber < Rails::Html::PermitScrubber
-    def initialize
-      super
-      self.tags = %w(i a div span strong br em h1 h2 h3 h4 h5 h6 blockquote)
-      self.attributes = %w(href class id)
-    end
-
-    def skip_node?(node)
-      node.text?
-    end
-  end
-end

data/lib/ama_layout/notification_set.rb

@@ -1,140 +0,0 @@
-module AmaLayout
-  # An array-like object that handles the storage and retrieval of notifications
-  # from the underlying data store.
-  #
-  # The raw serialization format is JSON as follows (keys are SHA256 hashes):
-  #
-  # {
-  #   "57107043eab0f60a37f7735307dc6fc6709d04eec2dbeea8c284958057af9b77": {
-  #     "type": "notice",
-  #     "brand": "membership",
-  #     "header": "test",
-  #     "content": "test",
-  #     "created_at": "2017-06-19T11:26:57.730-06:00",
-  #     "lifespan": 31557600,
-  #     "active": true,
-  #     "version": "1.0.0"
-  #   }
-  # }
-  #
-  class NotificationSet
-    include Enumerable
-    attr_accessor :base, :data_store, :key
-
-    delegate :each, :first, :last, :size, :[], :empty?, :any?,  to: :all
-
-    def initialize(data_store, key)
-      self.data_store = data_store
-      self.key = key
-      self.base = fetch
-      clean!
-    end
-
-    def active
-      all.select(&:active?)
-    end
-
-    def all
-      @all ||= normalize(base_notifications)
-    end
-
-    def create(args = {})
-      args[:created_at] = Time.current
-      args[:active] = true
-      notification = Notification.new(args)
-      # previously dismissed notifications always take precendence
-      all.push(notification) unless base.key?(notification.digest)
-      save
-    end
-
-    def destroy!
-      data_store.delete(key) && reload!
-    end
-
-    def delete(*digests)
-      digests = Array.wrap(digests.flatten)
-      delta = all.reject { |n| digests.include?(n.digest) }
-      if delta != all
-        @all = delta
-        save
-      end
-    end
-
-    def find(digest)
-      all.find { |n| n.id == digest }
-    end
-
-    def save
-      data_store.transaction do |store|
-        normalized = normalize(all)
-        self.base = serialize(normalized)
-        store.set(key, base.to_json)
-      end
-      reload!
-    end
-
-    def inspect
-      "<#{self.class.name}>: #{all}"
-    end
-    alias_method :to_s, :inspect
-
-    private
-
-    def clean!
-      if dirty?
-        all.reject!(&:stale?)
-        save
-      end
-    end
-
-    def dirty?
-      all.any?(&:stale?)
-    end
-
-    def reload!
-      @all = nil
-      self.base = fetch
-      all
-      self
-    end
-
-    def base_notifications
-      base.map { |k, v| Notification.new(v.merge(id: k)) }
-    end
-
-    def serialize(data)
-      data.inject({}) do |hash, element|
-        hash[element.digest] = element.to_h
-        hash
-      end
-    end
-
-    def normalize(data)
-      # sort by reverse chronological order
-      data.sort { |a, b| b <=> a }
-    end
-
-    def fetch
-      result = data_store.get(key)
-      result.present? ? build(result) : {}
-    end
-
-    def build(raw)
-      JSON.parse(raw)
-    rescue JSON::ParserError
-      data_store.delete(key) # we should try to prevent further errors
-      ::Rails.logger.error json_message(__FILE__, __LINE__, raw)
-      {}
-    end
-
-    def json_message(file, line, raw)
-      {
-        error: "#{self.class.name} - Invalid JSON",
-        file: file,
-        line: line,
-        key: key,
-        raw: raw
-      }.to_json
-    end
-  end
-end