stackable_flash 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+InstalledFiles
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+_yardoc
+.yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/CHANGELOG

@@ -0,0 +1,2 @@
+Version 0.0.1 - AUG.17.2012
+- Initial Release!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stackable_flash.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Peter Boling
+
+MIT License
+
+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.md

@@ -0,0 +1,80 @@
+stackable_flash
+===============
+
+Stackable Flash overrides the :[]= method of Rails' FlashHash to make it work like Array's :<< method instead, and makes each flash key an array.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stackable_flash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stackable_flash
+
+## Usage
+
+When turned on all flashes can be interacted with as arrays.
+
+    flash[:notice] = 'First message'              # Will have the same affect that pushing it onto an array would
+    flash[:notice] << 'Second message'            # No need to initialize first, or test to see if responds to :<<
+    flash[:notice] |= 'Third message'             # Will add this message only if unique in the stack
+    flash[:notice] += ['Fourth','Fifth']          # Will add all of the messages onto the stack individually.
+
+    flash[:notice] # is now: ['First message','Second message','Third message','Fourth','Fifth']
+
+But StackableFlash preserves existing functionality for code you already have written.
+
+    flash[:notice] += ' Appended'                  # Will append a message to the top/last message on the stack.
+
+    flash[:notice] # is now: ['First message','Second message','Third message','Fourth','Fifth Appended']
+
+    flash[:notice] = 'Overwrite'
+
+    flash[:notice] # is now: ['Overwrite']
+
+It is on by default.  To turn it off:
+
+    StackableFlash.stacked = false
+
+To turn it back on:
+
+    StackableFlash.stacked = true
+
+You can even start out with it off set a flash, turn it on, and add to the stack:
+
+    StackableFlash.stacked = false
+    flash[:notice] = 'string'
+    StackableFlash.stacked = true
+    flash[:notice] << 'string'
+
+There are block helpers which I am sure some enterprising individual will have a use for:
+
+    StackableFlash.stacked({:stack_with_proc => Proc.new {|arr| arr.map! {|x| "<p>#{x}</p>"}.join } } ) do
+      flash[:notice] = 'original'
+      flash[:notice] << 'message'
+      flash[:notice]        # => ['original','message']
+      flash[:notice].stack  # => '<p>original</p><p>message</p>'
+    end
+
+And
+
+    StackableFlash.not_stacked do
+      flash[:notice] = 'original'
+      flash[:notice] << ' message'
+      flash[:notice]        # => 'original message'
+      flash[:notice].stack  # => NoMethodError !!!
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+Bundler::GemHelper.install_tasks

data/lib/stackable_flash/config.rb

@@ -0,0 +1,38 @@
+module StackableFlash
+  class Config
+
+    class << self
+      attr_accessor :config
+    end
+
+    DEFAULTS = {
+      # Specify how stacked flashes at the same key (e.g. :notice, :errors) should be returned:
+      #
+      # Example:
+      #   flash[:notice] = 'Message 1'
+      #   flash[:notice] << 'Message 2'
+      #
+      # the flash[:notice] object now looks like when :stack_with_proc => lambda { |arr| arr }:
+      #
+      #   flash[:notice] # => ['Message 1','Message 2']
+      #
+      # the flash[:notice] object now looks like when :stack_with_proc => lambda { |arr| arr.join('<br/>') }:
+      #
+      #   flash[:notice] # => "Message 1<br/>Message 2"
+      #
+      # The default leaves the flash as a string of all the flashes joined by br tags,
+      #   to preserve compatibility with existing javascript, and/or views
+      #   that expect the flashes as a single string.
+      :stack_with_proc => Proc.new { |arr| arr.join('<br/>') }
+    }
+
+    #cattr_reader :config
+    #cattr_writer :config
+
+    self.config ||= DEFAULTS
+    def self.configure &block
+      yield @@config
+    end
+
+  end
+end

data/lib/stackable_flash/flash_stack.rb

@@ -0,0 +1,37 @@
+module StackableFlash
+  class FlashStack < Array
+
+    # Handle the following use case:
+    #   flash[:notice] = 'First Part'
+    #   flash[:notice] += ' Second Part'
+    # => ['First Part Second Part']
+    define_method "+_with_stacking", lambda {|to_add|
+      if StackableFlash.stacking
+        if to_add.kind_of?(Array)
+          self.send("+_without_stacking", to_add)
+        else
+          # Make sure it responds to +, otherwise just push it onto the stack
+          if self.last.respond_to?(:+)
+            self[self.length -1] = self.last + to_add
+          else
+            self << to_add
+          end
+        end
+      else
+        self.send("+_without_stacking", to_add)
+      end
+    }
+    alias_method_chain :+, :stacking
+
+    def stack
+      if StackableFlash.stacking
+        # Format the stacked flashes according to stack_with_proc lambda
+        StackableFlash::Config.config[:stack_with_proc].call(self)
+      else
+        # All StackableFlash functionality is completely bypassed
+        self
+      end
+    end
+
+  end
+end

data/lib/stackable_flash/stack_layer.rb

@@ -0,0 +1,47 @@
+require "stackable_flash/flash_stack"
+
+module StackableFlash
+  module StackLayer
+    def self.included(base)
+      base.send(:alias_method_chain, "[]=", "stacking")
+    end
+
+    define_method "[]_with_stacking=" do |key, value|
+      if StackableFlash.stacking
+        # Do it in a non-stacking block so we get normal behavior from flash[:notice] calls
+        StackableFlash.not_stacked do
+          # Make an array at the key, while providing a seamless upgrade to existing flashes
+          #
+          # Initial set to Array
+          #
+          # Principle of least surprise
+          # flash[:notice] = ['message1','message2']
+          # flash[:notice] # => ['message1','message2']
+          #
+          # Initial set to String
+          #
+          # Principle of least surprise
+          # flash[:notice] = 'original'
+          # flash[:notice] # => ['original']
+          #
+          # Overwrite!
+          #
+          # Principle of least surprise
+          # flash[:notice] = 'original'
+          # flash[:notice] = 'altered'
+          # flash[:notice] # => ['altered']
+          #
+          # The same line of code does all of the above:
+          self[key] = StackableFlash::FlashStack.new.replace(value.kind_of?(Array) ? value : Array(value))
+
+          # Leave existing behavior in place, but send the full array as the value so it doesn't get killed.
+          send("[]_without_stacking=", key, self[key])
+        end
+      else
+        # All StackableFlash functionality is completely bypassed
+        send("[]_without_stacking=", key, value)
+      end
+    end
+
+  end
+end

data/lib/stackable_flash/version.rb

@@ -0,0 +1,3 @@
+module StackableFlash
+  VERSION = "0.0.1"
+end

data/lib/stackable_flash.rb

@@ -0,0 +1,64 @@
+require "stackable_flash/version"
+require "stackable_flash/config"
+require "stackable_flash/flash_stack"
+require "stackable_flash/stack_layer"
+
+module StackableFlash
+  class << self
+    attr_accessor :stacking
+  end
+  self.stacking = true # Turn on stacking by default
+
+  # Regardless of the value of StackableFlash.stacking you can do a local override to force stacking.
+  #
+  # StackableFlash.stacked do
+  #   flash[:notice] = 'a simple string'  # Use flash as if this gem did not exist
+  #   flash[:notice] = 'another'          # will stack the strings
+  #   flash[:notice] # => ['a simple string','another'],
+  #                  #    but returned as "a simple string<br/>another" with default config
+  # end
+  #
+  def self.stacked(config_options = {}, &block)
+    flashing({:forcing => true}) do
+      original = StackableFlash::Config.config.dup
+      StackableFlash::Config.config.merge!(config_options)
+      yield
+      StackableFlash::Config.config = original
+    end
+  end
+
+  # Regardless of the value of StackableFlash.stacking you can do a local override to force non-stacking.
+  #
+  # StackableFlash.not_stacked do
+  #   flash[:notice] = 'a simple string'  # Use flash as if this gem did not exist
+  #   flash[:notice] = ''                 # will overwrite the string above
+  #   flash[:notice] # => ''
+  # end
+  #
+  def self.not_stacked &block
+    flashing({:forcing => false}) do
+      yield
+    end
+  end
+
+  def self.flashing(options, &block)
+    return false unless block_given?
+    original = StackableFlash.stacking
+    StackableFlash.stacking = options[:forcing]
+    yield
+    StackableFlash.stacking = original
+  end
+
+end
+
+require 'action_pack/version'
+base = begin
+  if ActionPack::VERSION::MAJOR >= 3
+    require 'action_dispatch'
+    ActionDispatch::Flash::FlashHash
+  else
+    require 'action_controller'
+    ActionController::Flash::FlashHash
+  end
+end
+base.send :include, StackableFlash::StackLayer

data/spec/controllers/dummy_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe DummyController do
+
+  render_views
+
+  it "should override" do
+    get :override
+    controller.flash[:notice].should == ['message']
+  end
+
+  it "should build a stack" do
+    get :stack
+    controller.flash[:notice].should == ['original','message','another']
+  end
+
+  it "should allow transformation" do
+    get :stack
+    controller.flash[:notice].stack.should == 'original<br/>message<br/>another'
+  end
+
+end
+

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

@@ -0,0 +1,14 @@
+class DummyController < ApplicationController
+  include StackableFlash
+  def override
+    flash[:notice] = 'original'
+    flash[:notice] = 'message'
+  end
+
+  def stack
+    flash[:notice] = 'original'
+    flash[:notice] << 'message'
+    flash[:notice] << 'another'
+  end
+
+end

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

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

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

@@ -0,0 +1,3 @@
+<p>
+  Here I am!  Index Action!
+</p>

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

@@ -0,0 +1,3 @@
+<p>
+  Here I am!  Error Action
+</p>

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

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+#require "active_record/railtie"
+require "action_controller/railtie"
+#require "action_mailer/railtie"
+#require "active_resource/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require
+require "stackable_flash"
+
+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.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # 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
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.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'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# 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:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

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

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

@@ -0,0 +1,30 @@
+Dummy::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
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # 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
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end