flash_messenger 0.0.1

data/spec/dummy/spec/controllers/index_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe IndexController, :type => :controller do
+
+end

data/spec/dummy/spec/helpers/index_helper_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+# Specs in this file have access to a helper object that includes
+# the IndexHelper. For example:
+#
+# describe IndexHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       expect(helper.concat_strings("this","that")).to eq("this that")
+#     end
+#   end
+# end
+RSpec.describe IndexHelper, :type => :helper do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/spec/examples/shared_examples.rb

@@ -0,0 +1,27 @@
+
+# These shared example test that a subject's accessor method is:
+#
+#   A) Publicly exposed
+#   B) Not nil
+#   c) Result "equal" to the `let` with the same name in context
+#
+# @param [Symbol] Method name as symbol
+# @param [*args] Arbitrary arguments to pass to the `send` call
+#
+RSpec.shared_examples 'a public accessor method' do |target, *args|
+  let(:result) do
+    subject.public_send(target, *(args.map { |i| public_send(i) }))
+  end
+
+  let(:expected) do
+    public_send(target)
+  end
+
+  it "publicly exposes ##{target}" do
+    expect(result).not_to be_nil
+  end
+
+  it 'has expected values' do
+    expect(result).to eq(expected)
+  end
+end

data/spec/features/messages/base_spec.rb

@@ -0,0 +1,102 @@
+require 'rails_helper'
+
+RSpec.shared_examples 'a helper which yields message of kind' do |klass, target, *args|
+  let(:klazz) { public_send(klass) }
+
+  let(:instance) do
+    subject.public_send(target, *(args.map { |i| public_send(i) }))
+  end
+
+  it_behaves_like 'a message instance of kind', :klazz, :instance
+end
+
+RSpec.shared_examples 'a message instance of kind' do |klass, target|
+  let(:kind) { public_send(klass) }
+  let(:victim) { public_send(target) }
+
+  it "returns an instance of #{klass}" do
+    expect(victim).to be_a(kind)
+  end
+
+  context '#serialization' do
+    it 'serializes and deserializes properly' do
+      expect(victim.to_session).to be_a(String)
+
+      another_victim = victim.class.from_session(victim.to_session)
+
+      expect(another_victim).to eq(victim)
+    end
+  end
+
+  # Note: inherits default_message from calling context
+  context '#message' do
+    it 'has the expected message' do
+      expect(victim.message).to eq(default_message)
+    end
+  end
+
+  context '#eql?' do
+    it 'equals another message instance with the same string' do
+      another_victim = victim.dup
+      expect(another_victim).to eq(victim)
+      expect(another_victim.__id__).not_to eq(victim.__id__)
+    end
+  end
+
+  context '#match?' do
+    it 'matches the string value' do
+      expect(victim).to match(victim.message)
+    end
+  end
+
+  context '#type?' do
+    it 'exposes its type helper properly' do
+      expect(victim.public_send("#{victim.level}?")).to be_truthy
+    end
+  end
+end
+
+RSpec.describe FlashMessenger::Messages::Base do
+  subject { FlashMessenger::Messages::Base }
+
+  let(:default_translation) { 'development.lorem_ipsum_1' }
+  let(:default_message) { I18n.t(default_translation) }
+  let(:default_level) { :notice }
+  let(:default_params) { { test: 'foo' } }
+
+  context 'with vanilla messages' do
+    let(:new_with_message) do
+      subject.new(default_level, default_message, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Nonpersistent object' do
+        expect(new_with_message).to be_a(subject)
+      end
+
+      it 'is defines the interface' do
+        expect { new_with_message.persistent? }.to raise_error(NotImplementedError)
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_message
+    end
+  end
+
+  context 'with i18n translations' do
+    let(:new_with_translation) do
+      subject.new(default_level, default_translation, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Nonpersistent object' do
+        expect(new_with_translation).to be_a(subject)
+      end
+
+      it 'is defines the interface' do
+        expect { new_with_translation.persistent? }.to raise_error(NotImplementedError)
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_translation
+    end
+  end
+end

data/spec/features/messages/nonpersistent_spec.rb

@@ -0,0 +1,46 @@
+require 'rails_helper'
+
+RSpec.describe FlashMessenger::Messages::Nonpersistent do
+  subject { FlashMessenger::Messages::Nonpersistent }
+
+  let(:default_translation) { 'development.lorem_ipsum_1' }
+  let(:default_message) { I18n.t(default_translation) }
+  let(:default_level) { :notice }
+  let(:default_params) { { test: 'foo' } }
+
+  context 'with vanilla messages' do
+    let(:new_with_message) do
+      subject.new(default_level, default_message, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Nonpersistent object' do
+        expect(new_with_message).to be_a(subject)
+      end
+
+      it 'is not persistent' do
+        expect(new_with_message.persistent?).to be_falsy
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_message
+    end
+  end
+
+  context 'with i18n translations' do
+    let(:new_with_translation) do
+      subject.new(default_level, default_translation, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Nonpersistent object' do
+        expect(new_with_translation).to be_a(subject)
+      end
+
+      it 'is not persistent' do
+        expect(new_with_translation.persistent?).to be_falsy
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_translation
+    end
+  end
+end

data/spec/features/messages/persistent_spec.rb

@@ -0,0 +1,46 @@
+require 'rails_helper'
+
+RSpec.describe FlashMessenger::Messages::Persistent do
+  subject { FlashMessenger::Messages::Persistent }
+
+  let(:default_translation) { 'development.lorem_ipsum_1' }
+  let(:default_message) { I18n.t(default_translation) }
+  let(:default_level) { :notice }
+  let(:default_params) { { test: 'foo' } }
+
+  context 'with vanilla messages' do
+    let(:new_with_message) do
+      subject.new(default_level, default_message, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Persistent object' do
+        expect(new_with_message).to be_a(subject)
+      end
+
+      it 'is persistent' do
+        expect(new_with_message.persistent?).to be_truthy
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_message
+    end
+  end
+
+  context 'with i18n translations' do
+    let(:new_with_translation) do
+      subject.new(default_level, default_translation, default_params)
+    end
+
+    context '#new' do
+      it 'returns a new FlashMessenger::Messages::Persistent object' do
+        expect(new_with_translation).to be_a(subject)
+      end
+
+      it 'is persistent' do
+        expect(new_with_translation.persistent?).to be_truthy
+      end
+
+      it_behaves_like 'a message instance of kind', :subject, :new_with_translation
+    end
+  end
+end

data/spec/features/messenger_spec.rb

@@ -0,0 +1,96 @@
+require 'pry'
+require 'spec_helper'
+
+RSpec.describe FlashMessenger, js: true do
+  subject { FlashMessenger }
+
+  let(:nonpersistent_message_klass) { FlashMessenger::Messages::Nonpersistent }
+  let(:persistent_message_klass) { FlashMessenger::Messages::Persistent }
+
+  let(:default_klass) { FlashMessenger::DEFAULT_MESSAGE_KLASS }
+  let(:default_translation) { 'development.lorem_ipsum_1' }
+  let(:default_message) { I18n.t(default_translation) }
+  let(:default_level) { :notice }
+  let(:default_params) { { test: 'foo' } }
+
+  context '#new' do
+    it 'returns a new FlashMessenger::Storage object' do
+      expect(subject.new).to be_a(FlashMessenger::Storage)
+    end
+
+    it 'with an empty message array' do
+      expect(subject.new.messages).to be_a(Array)
+      expect(subject.new.messages).to be_empty
+    end
+  end
+
+  context '#alert' do
+    let(:alert) { default_klass.alert(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :alert,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :alert,
+      :default_message
+  end
+
+  context '#error' do
+    let(:error) { default_klass.error(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :error,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :error,
+      :default_message
+  end
+
+  context '#info' do
+    let(:info) { default_klass.info(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :info,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :info,
+      :default_message
+  end
+
+  context '#notice' do
+    let(:notice) { default_klass.notice(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :notice,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :notice,
+      :default_message
+  end
+
+  context 'during user session' do
+    let(:flash_messenger) { FlashMessenger.new }
+
+    def cycle_messages(flash_messenger)
+      flash_messenger.each_message { |i| puts i }
+    end
+
+    it 'persists :persistent messages' do
+      flash_messenger.error "It is currently #{DateTime.now}.", :persistent
+
+      expect { cycle_messages(flash_messenger) }.not_to \
+        change { flash_messenger.messages.size }
+    end
+
+    it 'does not persist :nonpersistent messages' do
+      flash_messenger.error "It is currently #{DateTime.now}."
+
+      expect { cycle_messages(flash_messenger) }.to \
+        change { flash_messenger.messages.size }.by(-1)
+    end
+  end
+end

data/spec/features/storage_spec.rb

@@ -0,0 +1,152 @@
+require 'rails_helper'
+
+RSpec.describe FlashMessenger::Storage do
+  subject { FlashMessenger::Storage.new }
+
+  let(:nonpersistent_message_klass) { FlashMessenger::Messages::Nonpersistent }
+  let(:persistent_message_klass) { FlashMessenger::Messages::Persistent }
+
+  let(:default_klass) { nonpersistent_message_klass }
+  let(:default_translation) { 'development.lorem_ipsum_1' }
+  let(:default_message) { I18n.t(default_translation) }
+  let(:default_level) { :notice }
+  let(:default_params) { { test: 'foo' } }
+
+  let(:first_message) { subject.messages.first }
+  let(:second_message) { subject.messages[1] }
+  let(:third_message) { subject.messages[2] }
+  let(:last_message) { subject.messages.last }
+
+  context '#new' do
+    it 'returns a new FlashMessenger::Storage object' do
+      expect(subject).to be_a(FlashMessenger::Storage)
+    end
+
+    it 'with an empty message array' do
+      expect(subject.messages).to be_a(Array)
+      expect(subject.messages).to be_empty
+    end
+  end
+
+  context '#alert' do
+    let(:alert) { default_klass.alert(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :alert,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :alert,
+      :default_message
+  end
+
+  context '#error' do
+    let(:error) { default_klass.error(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :error,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :error,
+      :default_message
+  end
+
+  context '#info' do
+    let(:info) { default_klass.info(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :info,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :info,
+      :default_message
+  end
+
+  context '#notice' do
+    let(:notice) { default_klass.notice(default_message) }
+
+    it_behaves_like 'a public accessor method',
+      :notice,
+      :default_message
+
+    it_behaves_like 'a helper which yields message of kind', :default_klass,
+      :notice,
+      :default_message
+  end
+
+  context '#each' do
+    let(:nonpersistent_message) { nonpersistent_message_klass.alert(default_message) }
+    let(:persistent_message) { persistent_message_klass.alert(default_message) }
+
+    it 'records all messages' do
+      subject << nonpersistent_message
+      subject << persistent_message
+      expect(first_message).to match(nonpersistent_message.message)
+      expect(second_message).to match(persistent_message.message)
+    end
+
+    it 'does not allow duplicate messages of same type / level' do
+      expect(subject.messages).to be_empty
+      subject << persistent_message
+      subject << persistent_message
+      subject << nonpersistent_message
+      subject << nonpersistent_message
+      expect(subject.messages.size).to eq(2)
+    end
+
+    it 'iterates through all messages and persists the persistent messages' do
+      subject << nonpersistent_message
+      subject << persistent_message
+      read_messages = []
+      subject.each_message do |message|
+        read_messages << message
+      end
+      expect(read_messages).to include(nonpersistent_message)
+      expect(read_messages).to include(persistent_message)
+      expect(subject.messages.size).to eq(1)
+      expect(first_message).to eq(persistent_message)
+    end
+  end
+
+  context '#serialization' do
+    let(:nonpersistent_message) { nonpersistent_message_klass.alert(default_message) }
+    let(:persistent_message) { persistent_message_klass.alert(default_message) }
+
+    let(:expected_json) do
+      {
+        "locale" => "en-US",
+        "messages" => [
+          {
+            "i18n_params" => { "raise" => true },
+            "level" => "alert",
+            "translation" => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce id lobortis tortor. Nam cursus pharetra purus non elementum. Sed eu libero leo. Aliquam eget justo vel odio consectetur facilisis id a sapien. Duis pulvinar tincidunt suscipit. Quisque volutpat justo vitae fringilla lacinia. Aenean semper, nulla at mattis sagittis, purus felis aliquet lorem, sit amet suscipit dolor elit nec tellus. Pellentesque interdum nulla maximus massa elementum, at posuere augue scelerisque.",
+            "class" => "nonpersistent"
+          },
+          {
+            "i18n_params" => { "raise" => true },
+            "level" => "alert",
+            "translation" => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce id lobortis tortor. Nam cursus pharetra purus non elementum. Sed eu libero leo. Aliquam eget justo vel odio consectetur facilisis id a sapien. Duis pulvinar tincidunt suscipit. Quisque volutpat justo vitae fringilla lacinia. Aenean semper, nulla at mattis sagittis, purus felis aliquet lorem, sit amet suscipit dolor elit nec tellus. Pellentesque interdum nulla maximus massa elementum, at posuere augue scelerisque.",
+            "class" => "persistent"
+          }
+        ]
+      }.to_json
+    end
+
+    it 'serializes itself and messages' do
+      subject << nonpersistent_message
+      subject << persistent_message
+      expect(subject.to_session).to eq(expected_json)
+    end
+
+    it 'deserializes itself and messages' do
+      subject << nonpersistent_message
+      subject << persistent_message
+      deserialized_instance = subject.class.from_session(expected_json)
+      expect(deserialized_instance.messages.size).to eq(2)
+      expect(deserialized_instance.messages.first.persistent?).to be_falsy
+      expect(deserialized_instance.messages.last.persistent?).to be_truthy
+    end
+  end
+end