flash_messenger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbaa8f9d09975651d700f3f83efc33f48b70c0ba
+  data.tar.gz: bb74fbea64de6a21487f86604d1e7c0a8aa39e4e
+SHA512:
+  metadata.gz: fb881726eac15c98e10a09dc909b683b0661505fccc5dbd5b78dc7d792306f97efe5611ef53f7380043b1546fd2b8665f6ed2867ef81de3572f8e822aa8975f7
+  data.tar.gz: 959b2b22389bcb8681c1779e29fa1b375035c1586b938380a4b8966c7712ac87797c4742d52bf0b2edc7d221a11310a86b071691e755077a42c7744f461c7cd4

data/.gitignore

@@ -0,0 +1,23 @@
+*.a
+*.bundle
+*.o
+*.so
+.DS_Store
+.bundle/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+log/*.log
+mkmf.log
+pkg/
+spec/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format Fivemat
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+Style/Documentation:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: no_comma
+
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/CaseIndentation:
+  IndentOneStep: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/MethodLength:
+  Max: 7
+
+Metrics/ParameterLists:
+  Max: 4
+
+Metrics/LineLength:
+  Exclude:
+    - flash_messenger.gemspec
+
+Style/RegexpLiteral:
+  Exclude:
+    - flash_messenger.gemspec

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in flash_messenger.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= FlashMessenger
+
+This project rocks.

data/Rakefile

@@ -0,0 +1,26 @@
+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    = 'FlashMessenger'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+# load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/application_controller.rb

@@ -0,0 +1,39 @@
+class ApplicationController < ActionController::Base
+  # around_filter :synchronize_flash_messenger_session
+  #
+  # def flash_messenger
+  #   serialize_flash_messenger
+  #   deserialize_flash_messenger
+  # end
+  #
+  # protected
+  #
+  # def clear_flash_messenger_session
+  #   @flash_messenger = nil
+  #   session.delete(:flash_messenger)
+  #   initialize_flash_messenger
+  # end
+  #
+  # private
+  #
+  # def synchronize_flash_messenger_session(&block)
+  #   deserialize_flash_messenger
+  #   block.call
+  #   serialize_flash_messenger
+  # end
+  #
+  # def initialize_flash_messenger
+  #   @flash_messenger ||= FlashMessenger.new
+  #   session[:flash_messenger] ||= @flash_messenger.to_session
+  # end
+  #
+  # def serialize_flash_messenger
+  #   initialize_flash_messenger
+  #   session[:flash_messenger] = @flash_messenger.to_session
+  # end
+  #
+  # def deserialize_flash_messenger
+  #   initialize_flash_messenger
+  #   @flash_messenger = FlashMessenger.from_session(session[:flash_messenger])
+  # end
+end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/flash_messenger/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en-US.yml

@@ -0,0 +1,28 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en-US:
+  development:
+    lorem_ipsum_1: 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.
+    lorem_ipsum_2: Nulla sagittis quam at est tincidunt, at consectetur leo vehicula. Vestibulum et faucibus odio. Vivamus interdum consectetur metus vitae aliquam. Integer vitae felis diam. Vestibulum consectetur dictum magna eget finibus. Integer sit amet interdum augue. Nullam ultricies malesuada odio, at tincidunt nisi semper nec. Pellentesque vitae convallis ligula. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Ut vitae risus blandit, sodales nulla at, placerat dui.
+    lorem_ipsum_3: Curabitur at orci sodales, luctus enim ac, lobortis mi. Curabitur ut sapien purus. Duis volutpat nulla feugiat iaculis porta. Ut ultricies nunc maximus placerat lobortis. Morbi ac lacinia nulla, sit amet aliquet tellus. Morbi viverra volutpat turpis ac sodales. Cras lacinia, felis quis tincidunt gravida, lectus dolor lobortis ex, eu imperdiet lectus urna vel risus. In et malesuada diam. Praesent finibus a ligula id laoreet. Nunc at dolor in nibh fermentum auctor.
+    lorem_ipsum_4: Morbi eu leo ipsum. Praesent vehicula risus ut tortor mattis, sit amet varius nisl sagittis. Ut sed ante finibus, eleifend ligula nec, faucibus ligula. Cras eget ipsum eleifend, aliquam diam sit amet, placerat dui. Curabitur nec diam consequat, tristique velit ut, porta tortor. Vestibulum ullamcorper vel mi ut elementum. Donec vel neque urna.
+    lorem_ipsum_5: Sed tempus hendrerit justo id tristique. Fusce pharetra dictum metus et vulputate. Donec at sem vitae mi elementum dictum. Ut fermentum, lorem in porttitor interdum, diam mi fringilla nisl, at maximus tortor dolor nec turpis. Proin sollicitudin nec ligula vel tempor. Phasellus dapibus hendrerit blandit. Quisque mauris quam, cursus mollis nulla quis, eleifend sagittis turpis. Mauris dictum ligula et ultricies fermentum. Donec imperdiet nisl cursus, commodo odio ac, commodo neque. Vestibulum vitae pulvinar turpis. Quisque nec condimentum velit. Suspendisse elementum tincidunt felis id lacinia. Cras tempus sollicitudin tortor, non mollis massa aliquet non. Quisque molestie arcu a justo tincidunt venenatis.

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root to: 'index#index'
+end

data/flash_messenger.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "flash_messenger/version"
+
+Gem::Specification.new do |spec|
+  spec.name             = 'flash_messenger'
+  spec.version          = FlashMessenger::VERSION
+  spec.authors          = ['Adam Eberlin']
+  spec.email            = ['ae@adameberlin.com']
+  spec.homepage         = 'https://github.com/arkbot/flash_messenger'
+  spec.summary          = 'Persistent flash messenger.'
+  spec.description      = 'Persistent flash messenger.'
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'rails', '>= 4.0'
+  spec.add_dependency 'activesupport', '>= 4.0'
+
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'fivemat'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry'
+end

data/lib/flash_messenger.rb

@@ -0,0 +1,9 @@
+require 'flash_messenger/engine'
+require 'flash_messenger/controller_injection'
+
+module FlashMessenger
+  DEFAULT_LOCALE = :'en-US'
+  # Rails.configuration.tap do |c|
+  #   DEFAULT_LOCALE = c.flash_messenger.default_locale || c.i18n.default_locale
+  # end
+end

data/lib/flash_messenger/controller_injection.rb

@@ -0,0 +1,45 @@
+module FlashMessenger
+  module ControllerInjection
+    extend ActiveSupport::Concern
+
+    included do
+      around_filter :synchronize_flash_messenger_session
+
+      def flash_messenger
+        serialize_flash_messenger
+        deserialize_flash_messenger
+      end
+
+      protected
+
+      def clear_flash_messenger_session
+        @flash_messenger = nil
+        session.delete(:flash_messenger)
+        initialize_flash_messenger
+      end
+
+      private
+
+      def synchronize_flash_messenger_session(&block)
+        deserialize_flash_messenger
+        block.call
+        serialize_flash_messenger
+      end
+
+      def initialize_flash_messenger
+        @flash_messenger ||= FlashMessenger.new
+        session[:flash_messenger] ||= @flash_messenger.to_session
+      end
+
+      def serialize_flash_messenger
+        initialize_flash_messenger
+        session[:flash_messenger] = @flash_messenger.to_session
+      end
+
+      def deserialize_flash_messenger
+        initialize_flash_messenger
+        @flash_messenger = FlashMessenger.from_session(session[:flash_messenger])
+      end
+    end
+  end
+end

data/lib/flash_messenger/engine.rb

@@ -0,0 +1,14 @@
+require 'flash_messenger/messenger'
+
+module FlashMessenger
+  class Engine < ::Rails::Engine
+    isolate_namespace ::FlashMessenger
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/flash_messenger/messages/base.rb

@@ -0,0 +1,174 @@
+module FlashMessenger
+  module Messages
+    class Base
+      include ActiveModel::Model
+      include ActiveModel::Serializers::JSON
+      include ActiveModel::AttributeMethods
+      extend ActiveModel::Naming
+
+      attr_accessor :i18n_params, :level, :translation
+
+      def initialize(level, translation, **i18n_params)
+        @i18n_params, @level, @translation = i18n_params, level, translation
+      end
+
+      # Normalize hash and force :raise so we can catch exceptions
+      def i18n_params
+        @i18n_params[:raise] = true
+        @i18n_params.sort.to_h
+      end
+
+      def i18n_params=(params)
+        @i18n_params = Hash[params.map{ |k, v| [k.to_sym, v] }]
+      end
+
+      def level
+        @level.to_sym
+      end
+
+      def message
+        I18n.translate(self.translation, **self.i18n_params)
+      rescue I18n::MissingTranslationData
+        return self.translation.join('.') if self.translation.is_a?(Array)
+        self.translation
+      # rescue I18n::MissingInterpolationArgument
+        # TODO
+      end
+
+      def to_s
+        self.message.strip
+      end
+
+      #
+      # Overridden Comparison Operators
+      #
+
+      def <=>(other)
+        return (self.message <=> other) if other.is_a?(String)
+        return nil unless other.is_a?(self.class)
+        my_values = [self.message, self.level, self.class_name]
+        other_values = [other.message, other.level, self.class_name]
+        (my_values <=> other_values)
+      rescue NoMethodError
+        nil
+      end
+
+      def eql?(other)
+        (self.<=> other) == 0
+      end
+
+      def match?(other)
+        if other.is_a?(Base)
+          us = "#{self.class_name}, #{self.level}, #{self.message}"
+          them = "#{self.class_name}, #{self.level}, #{self.message}"
+          us =~ them
+        elsif other.is_a?(String)
+          self.to_s =~ other
+        end
+        nil
+      end
+
+      alias_method :==, :eql?
+
+      #
+      # Message Interface Definitions
+      #
+
+      def persistent?
+        raise NotImplementedError
+      end
+
+      #
+      # Message Helpers (by level)
+      #
+
+      def alert?
+        @level == :alert
+      end
+
+      def error?
+        @level == :error
+      end
+
+      def info?
+        @level == :info
+      end
+
+      def notice?
+        @level == :notice
+      end
+
+      def self.alert(message, **i18n_params)
+        new(:alert, message, **i18n_params)
+      end
+
+      def self.error(message, **i18n_params)
+        new(:error, message, **i18n_params)
+      end
+
+      def self.info(message, **i18n_params)
+        new(:info, message, **i18n_params)
+      end
+
+      def self.notice(message, **i18n_params)
+        new(:notice, message, **i18n_params)
+      end
+
+      def class_name
+        self.class.model_name.element
+      end
+
+      def self.class_name
+        model_name.element
+      end
+
+      #
+      # Serialization Helpers
+      #
+
+      def from_json(json, include_root=include_root_in_json)
+        super(JSON.parse(json).tap { |this| this.delete('class') }.to_json)
+      end
+
+      def serializable_hash(options = {})
+        super.merge({ 'class' => self.class_name })
+      end
+
+      def to_session
+        serializable_hash.to_json
+      end
+
+      def self.from_session(json)
+        new(:stub, nil).from_json(json, false)
+      end
+
+      #
+      # Required Serialization Interface Methods
+      #
+
+      attribute_method_suffix '_contrived?'
+      attribute_method_prefix 'clear_'
+      define_attribute_methods :i18n_params, :level, :translation
+
+      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
+    end
+  end
+end