ama_layout 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c88882b36b0a2d7a3934d821d418f6dbb04dc7fb
-  data.tar.gz: 9e8f31189b00d70f47c974da2c2d8fed0bea6da0
+  metadata.gz: 3c84576ab846039685676fea5a445c6bde97a418
+  data.tar.gz: 898f53f578677836a9f708c44117142217b49d3e
 SHA512:
-  metadata.gz: 9eb109d937fd157a2b3d255a8ec39e3e21912fae3f13bfb72815b1313a8bd71d099691a2a5820c277ffcd8bea4c80809a6f716ef3cfa1d4b447c38e8358eaf7e
-  data.tar.gz: 47023ecc3639248c175231fe82208e86e0fa81cea06fe64ebabda18924b02a32552dca1c4f59a21b38f10ea77408c5e9d0aef880f7fb8163f7aa478e5c63b158
+  metadata.gz: 1d15a754ed97115d0312f123885c591bb28498f6c7f17a99b00e5316256026ec9e2e0a25ca8a468a0fea441b26a8ebc0a622a6bd4b8c3e66f4df480254fa4fb2
+  data.tar.gz: 0fc6b11bd21ee5739d94dc2e3188bf9030302bdcb5eff52c4ffbf364e90045da1ec01d7bb9ab252deac6ffdb418203c543814c149ed51173cd1948091acfa505

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 2.2.2
 sudo: false
+services:
+  - redis-server

data/ama_layout.gemspec

@@ -4,31 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ama_layout/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ama_layout"
+  spec.name          = 'ama_layout'
   spec.version       = AmaLayout::VERSION
-  spec.authors       = ["Michael van den Beuken", "Ruben Estevez", "Jordan Babe", "Mathieu Gilbert", "Ryan Jones", "Darko Dosenovic", "Jonathan Weyermann", "Adam Melnyk", "Kayt Campbell", "Kathleen Robertson", "Jesse Doyle"]
-  spec.email         = ["michael.beuken@gmail.com", "ruben.a.estevez@gmail.com", "jorbabe@gmail.com", "mathieu.gilbert@ama.ab.ca", "ryan.michael.jones@gmail.com", "darko.dosenovic@ama.ab.ca", "jonathan.weyermann@ama.ab.ca", "adam.melnyk@ama.ab.ca", "kayt.campbell@ama.ab.ca", "kathleen.robertson@ama.ab.ca", "jesse.doyle@ama.ab.ca"]
+  spec.authors       = ['Michael van den Beuken', 'Ruben Estevez', 'Jordan Babe', 'Mathieu Gilbert', 'Ryan Jones', 'Darko Dosenovic', 'Jonathan Weyermann', 'Adam Melnyk', 'Kayt Campbell', 'Kathleen Robertson', 'Jesse Doyle']
+  spec.email         = ['michael.beuken@gmail.com', 'ruben.a.estevez@gmail.com', 'jorbabe@gmail.com', 'mathieu.gilbert@ama.ab.ca', 'ryan.michael.jones@gmail.com', 'darko.dosenovic@ama.ab.ca', 'jonathan.weyermann@ama.ab.ca', 'adam.melnyk@ama.ab.ca', 'kayt.campbell@ama.ab.ca', 'kathleen.robertson@ama.ab.ca', 'jesse.doyle@ama.ab.ca']
   spec.summary       = %q{.ama.ab.ca site layouts}
   spec.description   = %q{.ama.ab.ca site layouts}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/amaabca/ama_layout'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "foundation-rails", "~> 6.3.1.0"
-  spec.add_dependency "rails", "~> 4.2"
-  spec.add_dependency "draper", "~> 2.1"
-  spec.add_dependency "browser", "~> 2.0"
-  spec.add_dependency "breadcrumbs_on_rails", "~> 3.0.1"
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 11.0"
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "factory_girl"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "combustion"
-  spec.add_development_dependency "sqlite3"
+  spec.add_dependency 'foundation-rails', '~> 6.3.1.0'
+  spec.add_dependency 'rails', '~> 4.2'
+  spec.add_dependency 'draper', '~> 2.1'
+  spec.add_dependency 'browser', '~> 2.0'
+  spec.add_dependency 'breadcrumbs_on_rails', '~> 3.0.1'
+  spec.add_dependency 'redis-rails'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '>= 11.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'combustion'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'timecop'
 end

data/lib/ama_layout.rb

@@ -1,17 +1,23 @@
-require "ama_layout/version"
-require "rails/all"
-require "foundation-rails"
-require "draper"
-require "browser"
-require "breadcrumbs_on_rails"
-require "ama_layout/breadcrumb_builder"
-require "ama_layout/moneris"
-require "ama_layout/navigation"
-require "ama_layout/navigation_item"
-require "ama_layout/decorators/moneris_decorator"
-require "ama_layout/decorators/navigation_decorator"
-require "ama_layout/decorators/navigation_item_decorator"
-require "ama_layout/controllers/action_controller"
+require 'ama_layout/version'
+require 'rails/all'
+require 'foundation-rails'
+require 'draper'
+require 'browser'
+require 'breadcrumbs_on_rails'
+require 'redis-rails'
+require 'ama_layout/breadcrumb_builder'
+require 'ama_layout/moneris'
+require 'ama_layout/navigation'
+require 'ama_layout/navigation_item'
+require 'ama_layout/decorators/moneris_decorator'
+require 'ama_layout/decorators/navigation_decorator'
+require 'ama_layout/decorators/navigation_item_decorator'
+require 'ama_layout/controllers/action_controller'
+require 'ama_layout/notifications/abstract_store'
+require 'ama_layout/notifications/redis_store'
+require 'ama_layout/notification'
+require 'ama_layout/notification_set'
+require 'ama_layout/notifications'
 
 module AmaLayout
   module Rails

data/lib/ama_layout/notification.rb

@@ -0,0 +1,84 @@
+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, :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
+      @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}#{lifespan.to_i}#{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,
+        '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_set.rb

@@ -0,0 +1,130 @@
+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):
+  #
+  # {
+  #   "8ca9f850c18acc17643038b2341bee3ede8a24c0f3e92f56f2109ce49fdcb616": {
+  #     "type": "notice",
+  #     "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: :active
+
+    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 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

data/lib/ama_layout/notifications.rb

@@ -0,0 +1,73 @@
+module AmaLayout
+  # Usage:
+  #
+  # class MyClass
+  #   include AmaLayout::Notifications
+  #
+  #   notification_store AmaLayout::Notifications::RedisStore.new(options)
+  #   notification_foreign_key :a_method_name_or_proc # defaults to :id
+  #
+  #   ...
+  # end
+  #
+  module Notifications
+    InvalidNotificationStore = Class.new(StandardError)
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    module InstanceMethods
+      def notifications
+        @notifications ||= NotificationSet.new(_store, _foreign_key)
+      end
+
+      def notifications=(other)
+        @notifications = other
+      end
+
+      private
+
+      def _store
+        self.class._notification_store || invalid_store!
+      end
+
+      def _foreign_key
+        self.class._notification_foreign_key.call(self)
+      end
+
+      def invalid_store!
+        raise InvalidNotificationStore, 'a notification store must be specified'
+      end
+    end
+
+    module ClassMethods
+      def notification_store(store)
+        self._notification_store = store
+      end
+
+      def notification_foreign_key(key)
+        self._notification_foreign_key = key
+      end
+
+      def _notification_foreign_key
+        @_notification_foreign_key || Proc.new(&:id)
+      end
+
+      def _notification_store
+        @_notification_store
+      end
+
+      private
+
+      def _notification_store=(store)
+        @_notification_store = store
+      end
+
+      def _notification_foreign_key=(key)
+        @_notification_foreign_key = key.to_proc
+      end
+    end
+  end
+end

data/lib/ama_layout/notifications/abstract_store.rb

@@ -0,0 +1,17 @@
+module AmaLayout
+  module Notifications
+    class AbstractStore
+      def get(key, opts = {})
+        raise NotImplementedError, 'you must define a #get method in a subclass'
+      end
+
+      def set(key, value, opts = {})
+        raise NotImplementedError, 'you must define a #set method in a subclass'
+      end
+
+      def delete(key, opts = {})
+        raise NotImplementedError, 'you must define a #delete method in a subclass'
+      end
+    end
+  end
+end

data/lib/ama_layout/notifications/redis_store.rb

@@ -0,0 +1,38 @@
+module AmaLayout
+  module Notifications
+    class RedisStore < AbstractStore
+      delegate :clear, to: :base
+
+      attr_accessor :base
+
+      def initialize(opts = {})
+        self.base = ActiveSupport::Cache.lookup_store(
+          :redis_store,
+          opts.merge(raw: true)
+        )
+      end
+
+      def get(key, opts = {})
+        if opts.fetch(:default, false)
+          base.fetch(key) { opts[:default] }
+        else
+          base.read(key)
+        end
+      end
+
+      def set(key, value, opts = {})
+        base.write(key, value, opts) == 'OK'
+      end
+
+      def delete(key, opts = {})
+        base.delete(key, opts) == 1
+      end
+
+      def transaction
+        base.data.multi do
+          yield self
+        end
+      end
+    end
+  end
+end

data/lib/ama_layout/version.rb

@@ -1,3 +1,3 @@
 module AmaLayout
-  VERSION = '5.2.0'
+  VERSION = '5.4.0'
 end

data/spec/ama_layout/notification_set_spec.rb

@@ -0,0 +1,237 @@
+describe AmaLayout::NotificationSet do
+  let(:store) do
+    AmaLayout::Notifications::RedisStore.new(
+      db: 4,
+      namespace: 'test_notifications',
+      host: 'localhost'
+    )
+  end
+  let(:key) { 1 }
+  let(:duration) { AmaLayout::Notification::DEFAULT_LIFESPAN.to_i }
+  let(:store_key) { key.to_s }
+  let(:json) do
+    <<-JSON
+    {
+      "8ca9f850c18acc17643038b2341bee3ede8a24c0f3e92f56f2109ce49fdcb616": {
+        "type": "notice",
+        "header": "test",
+        "content": "test",
+        "created_at": "2017-06-19T06:00:00.000Z",
+        "active": true,
+        "lifespan": #{duration},
+        "version": "1.0.0"
+      }
+    }
+    JSON
+  end
+  let(:stale_json) do
+    <<-JSON
+    {
+      "d3c2bc71904100674325791b371db7446097f956ea76a304e787abd5f2588665": {
+        "type": "notice",
+        "header": "stale",
+        "content": "stale",
+        "created_at": "2012-06-19T06:00:00.000Z",
+        "active": true,
+        "lifespan": #{duration},
+        "version": "1.0.0"
+      }
+    }
+    JSON
+  end
+
+  subject { described_class.new(store, key) }
+
+  around(:each) do |example|
+    Timecop.freeze(Time.zone.local(2017, 6, 19)) do
+      store.clear
+      example.run
+      store.clear
+    end
+  end
+
+  describe '#intialize' do
+    context 'with valid JSON in data store' do
+      before(:each) do
+        store.set(store_key, notification)
+      end
+
+      context 'without stale notifications in the data store' do
+        let(:notification) { json }
+
+        it 'fetches the notifications' do
+          expect(subject.size).to eq(1)
+        end
+      end
+
+      context 'with stale notifications in the data store' do
+        let(:notification) { stale_json }
+
+        it 'returns an empty set' do
+          expect(subject).to be_empty
+        end
+
+        it 'cleans out stale notifications from the data store' do
+          subject
+          expect(store.get(store_key)).to eq('{}')
+        end
+      end
+    end
+
+    context 'with invalid JSON in data store' do
+      before(:each) do
+        store.set(store_key, '{"invalid_json":')
+      end
+
+      it 'logs to Rails logger' do
+        expect(Rails.logger).to receive(:error).with(instance_of(String))
+        subject
+      end
+
+      it 'deletes the key in data store' do
+        subject
+        expect(store.get(store_key)).to be nil
+      end
+
+      it 'returns an empty set' do
+        expect(subject).to be_empty
+      end
+
+      it 'sets the base attribute to a hash' do
+        expect(subject.base).to be_a(Hash)
+      end
+    end
+
+    context 'with no entry in data store' do
+      it 'returns an empty set' do
+        expect(subject).to be_empty
+      end
+    end
+  end
+
+  describe '#create' do
+    it 'returns the NotificationSet instance' do
+      expect(subject.create(header: 'test', content: 'test')).to be_a(described_class)
+    end
+
+    it 'creates a new active notification' do
+      subject.create(header: 'test', content: 'test')
+      expect(subject.size).to eq(1)
+    end
+
+    it 'saves a notification in data store' do
+      subject.create(header: 'test', content: 'test')
+      expect(store.get(store_key)).to be_a(String)
+    end
+
+    context 'when the same notification exists but is dismissed' do
+      before(:each) do
+        store.set(store_key, json)
+        subject.first.dismiss!
+        subject.save
+        subject.create(header: 'test', content: 'test')
+      end
+
+      it 'does not overwrite the notification' do
+        expect(subject).to be_empty # we have only non-active notifications
+      end
+
+      it 'still has the dismissed notification in the data store' do
+        data = JSON.parse(store.get(store_key))
+        notification = data.values.first
+        expect(data.values.first['active']).to be false
+      end
+    end
+  end
+
+  describe '#destroy' do
+    context 'when data is removed' do
+      before(:each) do
+        subject.create(header: 'test', content: 'test', lifespan: 1.day)
+      end
+
+      it 'returns a NotificationSet instance' do
+        expect(subject.destroy!).to be_a(described_class)
+      end
+
+      it 'removes the notifications from the data store' do
+        subject.destroy!
+        expect(store.get(store_key)).to be nil
+      end
+
+      it 'returns an empty set' do
+        expect(subject.destroy!).to be_empty
+      end
+    end
+
+    context 'when data is not removed' do
+      it 'returns false' do
+        expect(subject.destroy!).to be false
+      end
+    end
+  end
+
+  describe '#find' do
+    context 'when id is not preset' do
+      it 'returns nil' do
+        expect(subject.find('invalid')).to be nil
+      end
+    end
+
+    context 'when id is present' do
+      let(:id) { subject.last.id }
+
+      before(:each) do
+        subject.create(header: 'test', content: 'test')
+      end
+
+      it 'returns the notification' do
+        expect(subject.find(id)).to eq(subject.last)
+      end
+    end
+  end
+
+  describe '#save' do
+    before(:each) do
+      subject.create(header: 'test', content: 'test')
+    end
+
+    it 'saves the notifications' do
+      expect(subject.last.active?).to be true
+      subject.last.dismiss!
+      subject.save
+      expect(subject).to be_empty
+    end
+
+    it 'returns the NotificationSet instance' do
+      expect(subject.save).to be_a(described_class)
+    end
+  end
+
+  describe '#inspect' do
+    it 'returns a stringified instance' do
+      expect(subject.inspect).to eq('<AmaLayout::NotificationSet>: []')
+    end
+  end
+
+  context 'scoping' do
+    before(:each) do
+      subject.create(header: 'test', content: 'test')
+      subject.create(header: 'inactive', content: 'inactive')
+      subject.last.dismiss!
+      subject.save
+    end
+
+    describe '#all' do
+      it 'returns both active and inactive notifications' do
+        expect(subject.all.size).to eq(2)
+      end
+    end
+
+    describe '#active' do
+      it 'returns only active notifications' do
+        expect(subject.active.size).to eq(1)
+      end
+    end
+  end
+end

data/spec/ama_layout/notification_spec.rb

@@ -0,0 +1,193 @@
+describe AmaLayout::Notification do
+  let(:instance) do
+    described_class.new(
+      header: 'test',
+      content: 'test',
+      active: true,
+      created_at: Time.current
+    )
+  end
+
+  describe '#initialize' do
+    let(:lifespan) { 1.day }
+
+    subject do
+      described_class.new(
+        header: 'test',
+        'content': 'test',
+        'active': true,
+        'created_at': time,
+        'lifespan': lifespan
+      )
+    end
+
+    context 'with a time created_at attribute' do
+      let(:time) { Time.current }
+
+      it 'accepts both symbols and strings as hash keys' do
+        expect(subject.header).to eq('test')
+        expect(subject.active).to be true
+      end
+
+      it 'sets a version by default' do
+        expect(subject.version).to eq(described_class::FORMAT_VERSION)
+      end
+    end
+
+    context 'with a string created_at attribute' do
+      let(:time) { '1984-01-01' }
+
+      it 'parses the string as a time' do
+        expect(subject.created_at).to eq(Time.zone.parse(time))
+      end
+    end
+
+    context 'with an Integer/Fixnum lifespan attribute' do
+      let(:time) { Time.current }
+      let(:lifespan) { 3600 }
+
+      it 'parses the integer to a duration of seconds' do
+        expect(subject.lifespan).to eq(lifespan.seconds)
+      end
+    end
+
+    context 'with an invalid type attribute' do
+      let(:parameters) do
+        {
+          type: :invalid,
+          header: 'test',
+          content: 'test',
+          created_at: Time.current,
+          active: true
+        }
+      end
+
+      it 'raises ArgumentError' do
+        expect { described_class.new(parameters) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#<=>' do
+    let(:old) do
+      described_class.new(
+        header: 'test',
+        content: 'test',
+        active: true,
+        created_at: Date.new(1984)
+      )
+    end
+    let(:new) do
+      described_class.new(
+        header: 'test',
+        content: 'test',
+        active: true,
+        created_at: Date.new(2017)
+      )
+    end
+
+    it 'sorts by created_at date' do
+      expect(old <=> new).to eq(-1)
+    end
+  end
+
+  describe '#active?' do
+    subject do
+      described_class.new(
+        header: 'test',
+        content: 'test',
+        active: active,
+        created_at: Time.current
+      )
+    end
+
+    context 'when active' do
+      let(:active) { true }
+
+      it 'returns true' do
+        expect(subject.active?).to be true
+      end
+    end
+
+    context 'when inactive' do
+      let(:active) { false }
+
+      it 'returns false' do
+        expect(subject.active?).to be false
+      end
+    end
+  end
+
+  describe 'dismissed?' do
+    subject do
+      described_class.new(
+        header: 'test',
+        content: 'test',
+        active: active,
+        created_at: Time.current
+      )
+    end
+
+    context 'when active' do
+      let(:active) { true }
+
+      it 'returns false' do
+        expect(subject.dismissed?).to be false
+      end
+    end
+
+    context 'when inactive' do
+      let(:active) { false }
+
+      it 'returns true' do
+        expect(subject.dismissed?).to be true
+      end
+    end
+  end
+
+  describe '#dismiss!' do
+    it 'returns true' do
+      expect(instance.dismiss!).to be true
+    end
+
+    it 'sets the :active flag to false' do
+      instance.dismiss!
+      expect(instance.active?).to be false
+    end
+  end
+
+  describe '#digest' do
+    context 'with the same objects' do
+      let(:other) { instance.dup }
+
+      it 'produces the same digest' do
+        expect(instance.digest).to eq(other.digest)
+      end
+    end
+
+    context 'with different objects' do
+      let(:other) do
+        described_class.new(
+        header: 'other',
+        content: 'other',
+        active: true,
+        created_at: Time.current
+      )
+      end
+
+      it 'produces different digests' do
+        expect(instance.digest).to_not eq(other.digest)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    it 'returns a hash' do
+      expect(instance.to_h).to be_a(Hash)
+    end
+
+    it 'is not empty' do
+      expect(instance.to_h).to_not be_empty
+    end
+  end
+end

data/spec/ama_layout/notifications/abstract_store_spec.rb

@@ -0,0 +1,23 @@
+describe AmaLayout::Notifications::AbstractStore do
+  context 'when inheriting' do
+    subject { Class.new(described_class).new }
+
+    describe '#get' do
+      it 'raises NotImplementedError' do
+        expect { subject.get('test') }.to raise_error(NotImplementedError)
+      end
+    end
+
+    describe '#set' do
+      it 'raises NotImplementedError' do
+        expect { subject.set('test', 'test') }.to raise_error(NotImplementedError)
+      end
+    end
+
+    describe '#delete' do
+      it 'raises NotImplementedError' do
+        expect { subject.delete('test') }.to raise_error(NotImplementedError)
+      end
+    end
+  end
+end

data/spec/ama_layout/notifications/redis_store_spec.rb

@@ -0,0 +1,94 @@
+describe AmaLayout::Notifications::RedisStore do
+  subject do
+    described_class.new(
+      db: 4,
+      namespace: 'test_notifications',
+      host: 'localhost'
+    )
+  end
+
+  around(:each) do |example|
+    subject.clear
+    example.run
+    subject.clear
+  end
+
+  describe '#get' do
+    context 'when a key is not present' do
+      it 'returns nil' do
+        expect(subject.get('missing')).to be nil
+      end
+    end
+
+    context 'when a key is present' do
+      before(:each) do
+        subject.set('key', 'value')
+      end
+
+      it 'returns the value' do
+        expect(subject.get('key')).to eq('value')
+      end
+    end
+
+    context 'with a default value' do
+      it 'sets a nil key to the default value' do
+        subject.get('missing', default: 'test')
+        expect(subject.get('missing')).to eq('test')
+      end
+    end
+  end
+
+  describe '#set' do
+    it 'sets the value for a given key' do
+      subject.set('test', 'value')
+      expect(subject.get('test')).to eq('value')
+    end
+
+    it 'returns true' do
+      expect(subject.set('test', 'value')).to be true
+    end
+  end
+
+  describe '#delete' do
+    context 'when a value is deleted' do
+      before(:each) do
+        subject.set('key', 'value')
+      end
+
+      it 'returns true' do
+        expect(subject.delete('key')).to be true
+      end
+
+      it 'deletes the key' do
+        subject.delete('key')
+        expect(subject.get('key')).to be nil
+      end
+    end
+
+    context 'when a value is not deleted' do
+      it 'returns false' do
+        expect(subject.delete('key')).to be false
+      end
+    end
+  end
+
+  describe '#transaction' do
+    it 'does not commit if an exception is raised' do
+      begin
+        subject.transaction do |store|
+          store.set('key', 'value')
+          raise StandardError
+        end
+      rescue StandardError
+      end
+      expect(subject.get('key')).to be nil
+    end
+
+    it 'commits to redis successfully' do
+      subject.transaction do |store|
+        store.set('key', 'value')
+      end
+      expect(subject.get('key')).to eq('value')
+    end
+  end
+end

data/spec/ama_layout/notifications_spec.rb

@@ -0,0 +1,109 @@
+describe AmaLayout::Notifications do
+  let(:store) do
+    AmaLayout::Notifications::RedisStore.new(
+      db: 4,
+      namespace: 'test_notifications',
+      host: 'localhost'
+    )
+  end
+  let(:json) do
+    <<-JSON
+    {
+      "8ca9f850c18acc17643038b2341bee3ede8a24c0f3e92f56f2109ce49fdcb616": {
+        "type": "notice",
+        "header": "test",
+        "content": "test",
+        "created_at": "2017-06-19T06:00:00.000Z",
+        "active": true,
+        "lifespan": 31557600,
+        "version": "1.0.0"
+      }
+    }
+    JSON
+  end
+
+  around(:each) do |example|
+    Timecop.freeze(Time.zone.local(2017, 6, 19)) do
+      store.clear
+      example.run
+      store.clear
+    end
+  end
+
+  context 'when including module' do
+    let(:klass) { Class.new.include(described_class) }
+
+    context 'class methods' do
+      before(:each) do
+        klass.class_eval do
+          notification_store AmaLayout::Notifications::RedisStore.new(
+            db: 4,
+            namespace: 'test_notifications',
+            host: 'localhost'
+          )
+          notification_foreign_key :my_id
+
+          def my_id
+            @id ||= SecureRandom.uuid
+          end
+        end
+      end
+
+      describe '#_notification_foreign_key' do
+        it 'returns the id method as a proc' do
+          expect(klass._notification_foreign_key).to be_a(Proc)
+        end
+      end
+
+      describe '#_notification_store' do
+        it 'returns the set data store' do
+          expect(klass._notification_store).to be_an(AmaLayout::Notifications::RedisStore)
+        end
+      end
+    end
+
+    context 'instance methods' do
+      context 'with a valid notification store' do
+        subject { klass.new }
+
+        before(:each) do
+          klass.class_eval do
+            notification_store AmaLayout::Notifications::RedisStore.new(
+              db: 4,
+              namespace: 'test_notifications',
+              host: 'localhost'
+            )
+            notification_foreign_key :my_id
+
+            def my_id
+              @id ||= SecureRandom.uuid
+            end
+          end
+        end
+
+        describe '#notifications' do
+          before(:each) do
+            store.set(subject.my_id, json)
+          end
+
+          it 'fetches notifications from data store' do
+            expect(subject.notifications.size).to eq(1)
+          end
+        end
+
+        describe '#notifications=' do
+          it 'resets the notifications to nil' do
+            subject.notifications = nil
+            expect(subject.notifications).to be_empty
+          end
+        end
+      end
+
+      context 'with an undefined notification store' do
+        it 'raises InvalidNotificationStore' do
+          expect { klass.new.notifications }.to raise_error(AmaLayout::Notifications::InvalidNotificationStore)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,15 +1,16 @@
-require "simplecov"
-require "factory_girl"
-require "ama_layout"
-require "pry"
-require "rspec/rails"
-require "combustion"
+require 'simplecov'
+require 'factory_girl'
+require 'ama_layout'
+require 'pry'
+require 'rspec/rails'
+require 'combustion'
+require 'timecop'
 
-ENV["RAILS_ENV"] ||= "test"
+ENV['RAILS_ENV'] ||= 'test'
 
 Combustion.initialize! :all
 
-Dir["./spec/support/**/*.rb"].sort.each { |file| require file }
+Dir['./spec/support/**/*.rb'].sort.each { |file| require file }
 
 FactoryGirl.find_definitions
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ama_layout
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Michael van den Beuken
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foundation-rails
@@ -90,6 +90,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: redis-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,14 +122,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '11.0'
 - !ruby/object:Gem::Dependency
@@ -202,6 +216,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
 description: ".ama.ab.ca site layouts"
 email:
 - michael.beuken@gmail.com
@@ -278,6 +306,11 @@ files:
 - lib/ama_layout/navigation.rb
 - lib/ama_layout/navigation.yml
 - lib/ama_layout/navigation_item.rb
+- lib/ama_layout/notification.rb
+- lib/ama_layout/notification_set.rb
+- lib/ama_layout/notifications.rb
+- lib/ama_layout/notifications/abstract_store.rb
+- lib/ama_layout/notifications/redis_store.rb
 - lib/ama_layout/version.rb
 - spec/ama_layout/breadcrumb_builder_spec.rb
 - spec/ama_layout/controllers/pages_controller_spec.rb
@@ -290,6 +323,11 @@ files:
 - spec/ama_layout/moneris_spec.rb
 - spec/ama_layout/navigation_item_spec.rb
 - spec/ama_layout/navigation_spec.rb
+- spec/ama_layout/notification_set_spec.rb
+- spec/ama_layout/notification_spec.rb
+- spec/ama_layout/notifications/abstract_store_spec.rb
+- spec/ama_layout/notifications/redis_store_spec.rb
+- spec/ama_layout/notifications_spec.rb
 - spec/factories/navigation.rb
 - spec/factories/navigation_item.rb
 - spec/helpers/ama_layout_breadcrumb_helper_spec.rb
@@ -303,8 +341,7 @@ files:
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/spec_helper.rb
-- styles.scss
-homepage: ''
+homepage: https://github.com/amaabca/ama_layout
 licenses:
 - MIT
 metadata: {}
@@ -324,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: ".ama.ab.ca site layouts"
@@ -340,6 +377,11 @@ test_files:
 - spec/ama_layout/moneris_spec.rb
 - spec/ama_layout/navigation_item_spec.rb
 - spec/ama_layout/navigation_spec.rb
+- spec/ama_layout/notification_set_spec.rb
+- spec/ama_layout/notification_spec.rb
+- spec/ama_layout/notifications/abstract_store_spec.rb
+- spec/ama_layout/notifications/redis_store_spec.rb
+- spec/ama_layout/notifications_spec.rb
 - spec/factories/navigation.rb
 - spec/factories/navigation_item.rb
 - spec/helpers/ama_layout_breadcrumb_helper_spec.rb