flash_messenger 0.0.1

data/lib/flash_messenger/messages/nonpersistent.rb

@@ -0,0 +1,9 @@
+module FlashMessenger
+  module Messages
+    class Nonpersistent < Base
+      def persistent?
+        false
+      end
+    end
+  end
+end

data/lib/flash_messenger/messages/persistent.rb

@@ -0,0 +1,9 @@
+module FlashMessenger
+  module Messages
+    class Persistent < Base
+      def persistent?
+        true
+      end
+    end
+  end
+end

data/lib/flash_messenger/messenger.rb

@@ -0,0 +1,25 @@
+require 'flash_messenger/storage'
+require 'flash_messenger/messages/base'
+require 'flash_messenger/messages/nonpersistent'
+require 'flash_messenger/messages/persistent'
+
+module FlashMessenger
+  DEFAULT_MESSAGE_KLASS = Messages::Nonpersistent
+
+  module Nonpersistent
+    class << self
+      delegate :alert, :error, :info, :notice, :new, to: DEFAULT_MESSAGE_KLASS
+    end
+  end
+
+  module Persistent
+    class << self
+      delegate :alert, :error, :info, :notice, :new, to: Messages::Persistent
+    end
+  end
+
+  class << self
+    delegate :from_session, :new, :to_session, to: Storage
+    delegate :alert, :error, :info, :notice, to: DEFAULT_MESSAGE_KLASS
+  end
+end

data/lib/flash_messenger/storage.rb

@@ -0,0 +1,141 @@
+module FlashMessenger
+  class Storage
+    include ActiveModel::Model
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::AttributeMethods
+    extend ActiveModel::Naming
+
+    attr_accessor :locale, :messages
+
+    def initialize(locale = DEFAULT_LOCALE.to_sym)
+      @locale, @messages = locale.to_sym, []
+    end
+
+    def <<(message)
+      return unless message.is_a?(Messages::Base)
+      return if @messages.any? { |i| message.eql?(i) }
+      @messages << message
+    end
+
+    def each_message(&block)
+      read_messages = []
+      I18n.with_locale(@locale) do
+        @messages.each do |message|
+          block.call(message) if block_given?
+          read_messages << message unless message.persistent?
+        end
+      end
+      read_messages.each { |i| @messages.delete(i) }
+    end
+
+    def delete(message_or_translation)
+      matcher = /#{message_or_translation}/
+      @messages.delete_if do |message|
+        message.to_s =~ matcher ||
+          message.translation =~ matcher
+      end
+    end
+
+    #
+    # Message Helpers (by level)
+    #
+
+    def alerts
+      @messages.select(&:alert?)
+    end
+
+    def errors
+      @messages.select(&:error?)
+    end
+
+    def notices
+      @messages.select(&:notice?)
+    end
+
+    def infos
+      @messages.select(&:info?)
+    end
+
+    def alert(msg, klass = DEFAULT_MESSAGE_KLASS, **i18n_params)
+      add(klass, :alert, msg, **i18n_params)
+    end
+
+    def error(msg, klass = DEFAULT_MESSAGE_KLASS, **i18n_params)
+      add(klass, :error, msg, **i18n_params)
+    end
+
+    def info(msg, klass = DEFAULT_MESSAGE_KLASS, **i18n_params)
+      add(klass, :info, msg, **i18n_params)
+    end
+
+    def notice(msg, klass = DEFAULT_MESSAGE_KLASS, **i18n_params)
+      add(klass, :notice, msg, **i18n_params)
+    end
+
+    def add(klass, level, msg, **i18n_params)
+      classify(klass).send(level, msg, **i18n_params).tap do |instance|
+        self.<< instance
+      end
+    end
+
+    #
+    # Serialization Helpers
+    #
+
+    def from_json(json, include_root = include_root_in_json)
+      super.tap do |instance|
+        instance.messages = instance.messages.collect do |m|
+          m.is_a?(Hash) ? classify(m['class']).from_session(m.to_json) : m
+        end
+      end
+    end
+
+    def serializable_hash
+      super.tap do |instance|
+        instance['messages'].map!(&:serializable_hash)
+      end
+    end
+
+    def to_session
+      serializable_hash.to_json
+    end
+
+    def self.from_session(json)
+      new.from_json(json, false)
+    end
+
+    #
+    # Required Serialization Interface Methods
+    #
+
+    attribute_method_suffix '_contrived?'
+    attribute_method_prefix 'clear_'
+    define_attribute_methods :locale, :messages
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    private
+
+    def attribute_contrived?(attr)
+      true
+    end
+
+    def clear_attribute(attr)
+      send("#{attr}=", nil)
+    end
+
+    # Normalize :persistent / :nonpersistent to actual class reference
+    def classify(name)
+      return name unless name.is_a?(String) || name.is_a?(Symbol)
+      "::FlashMessenger::Messages::#{name.to_s.classify}".safe_constantize
+    end
+  end
+end

data/lib/flash_messenger/version.rb

@@ -0,0 +1,3 @@
+module FlashMessenger
+  VERSION = '0.0.1'
+end

data/lib/tasks/flash_messenger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :flash_messenger do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/index.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/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 vendor/assets/stylesheets of plugins, if any, 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/index.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  include FlashMessenger::ControllerInjection
+end

data/spec/dummy/app/controllers/index_controller.rb

@@ -0,0 +1,6 @@
+class IndexController < ApplicationController
+  def index
+    flash_messenger.info "This is an :info message"
+    render :index, locals: { flash_messenger: flash_messenger }
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/index_helper.rb

@@ -0,0 +1,2 @@
+module IndexHelper
+end

data/spec/dummy/app/views/index/index.html.erb

@@ -0,0 +1,5 @@
+<html>
+<body>
+<p><%= flash_messenger.inspect %></p>
+</body>
+</html>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "flash_messenger"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end