stackable_flash 0.0.7 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e318b882bf80aa565f9a7790ba2eb145531c7c88
+  data.tar.gz: 69edded26007e9e2293d73ef9cd882c9a793d22d
+SHA512:
+  metadata.gz: 4b426181a3964f8f6c6e0a62ee420bf86cfc6b5db57e157a9af814359841d0f97898080c125750666b9b5c8f167249ed62ff0c6a4b0f6b36c6df18d841eee5cd
+  data.tar.gz: f3e4de1337bfcbb43965b326cb0d0ddca4b3d202cc188f7c1113fa11358cfdf6947bf257281b4c6afd3a25cc4dabca15a916cd621581371bda7d5a3ba4eabb3f

data/.gitignore

@@ -12,6 +12,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/dummy/log/*
 
 # YARD artifacts
 _yardoc

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 1.9.2
-  - jruby-19mode
-  - rbx-19mode
+  - 2.0.0
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - ruby-head
-  - jruby-head
+
+script: bundle exec rspec

data/CHANGELOG

@@ -1,3 +1,7 @@
+Version 0.1.0 - MAY.23.2017
+- Remove usage of alias_method_chain
+- Dropped support for Ruby 1.9.3 (Now requires >= 2.0)
+
 Version 0.0.7 - AUG.22.2012
 - Working Config class
 

data/README.md

@@ -1,7 +1,35 @@
 stackable_flash
 ===============
 
-Allows flashes to stack intelligently, while preserving existing behavior of Rails' FlashHash.
+* Allows flashes to stack intelligently like arrays.
+* Follows the *principle of least surprise* for existing behavior of Rails' FlashHash.
+
+| Project                 |  Stackable Flash  |
+|------------------------ | ----------------- |
+| gem name                |  stackable_flash  |
+| license                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
+| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| download rank           |  [![Total Downloads](https://img.shields.io/gem/rt/stackable_flash.svg)](https://rubygems.org/gems/stackable_flash) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/stackable_flash.png)](http://badge.fury.io/rb/stackable_flash) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/stackable_flash.png)](https://gemnasium.com/pboling/stackable_flash) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/stackable_flash.png)](https://codeclimate.com/github/pboling/stackable_flash) |
+| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/stackable_flash.png)](http://inch-ci.org/github/pboling/stackable_flash) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/stackable_flash.png?branch=master)](https://travis-ci.org/pboling/stackable_flash) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/stackable_flash/badge.png)](https://coveralls.io/r/pboling/stackable_flash) |
+| homepage                |  [on Github.com][homepage] |
+| documentation           |  [on Rdoc.info][documentation] |
+| live chat               |  [![Join the chat at https://gitter.im/pboling/stackable_flash](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/stackable_flash?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on Coderwall][coderwall] |
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[coderwall]: http://coderwall.com/pboling
+[documentation]: http://rdoc.info/github/pboling/stackable_flash/frames
+[homepage]: https://github.com/pboling/stackable_flash
+
+## Description
 
 Stackable Flash overrides the `:[]=` method of Rails' FlashHash with the result being that each flash key is an array.
 It is designed following the "Principle of least surprise", so in most ways the flash works as it always has.
@@ -78,12 +106,20 @@ You can even start out with it off set a flash, turn it on, and add to the stack
 
 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']
+    StackableFlash.stacked do
+      flash[:notice] = 'a simple string'  # You can continue to use flash as if this gem did not exist
+      flash[:notice] << 'another'         # will stack the strings
+      flash[:notice]                      # => ['a simple string','another'],
       # Uses the :stack_with_proc to transform
-      flash[:notice].stack  # => '<p>original</p><p>message</p>'
+      flash[:notice].stack                # => "a simple string<br/>another" (default config uses <br/>),
+      flash[:notice] = ''                 # will overwrite everything above, and set back to empty string
+    end
+
+    StackableFlash.stacked({:stack_with_proc => Proc.new {|arr| arr.map! {|x| "<p>#{x}</p>"}.join } } ) do
+      flash[:error] = 'original'
+      flash[:error] << 'message'
+      flash[:error]        # => ['original','message']
+      flash[:error].stack  # => '<p>original</p><p>message</p>'
     end
 
 And
@@ -98,7 +134,8 @@ And
 
 ## Sightings
 
-This gem is used by the cacheable_flash gem to provide stacking flashes.  You can check it out for a working example.
+This gem is used by the [cacheable_flash](https://github.com/pboling/cacheable-flash) gem to provide stacking flashes.
+You can check it out for a working example.
 
 ## Contributing
 
@@ -109,8 +146,27 @@ This gem is used by the cacheable_flash gem to provide stacking flashes.  You ca
 5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 6. Create new Pull Request
 
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically, 
+if a minor or patch version is released that breaks backward 
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will 
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a 
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision. 
+
+For example:
+
+    spec.add_dependency 'stackable_flash', '~> 4.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
 ## Copyright
 
 Licensed under the MIT License.
 
-* Copyright (c) 2012 Peter H. Boling (http://peterboling.com). See LICENSE for further details.
+* Copyright (c) 2012-17 Peter H. Boling (http://railsbling.com). See LICENSE for further details.

data/lib/stackable_flash.rb

@@ -16,12 +16,22 @@ module StackableFlash
 
   # 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
+  #  StackableFlash.stacked do
+  #     flash[:notice] = 'a simple string'  # You can continue to use flash as if this gem did not exist
+  #     flash[:notice] << 'another'         # will stack the strings
+  #     flash[:notice]                      # => ['a simple string','another'],
+  #     # Uses the default :stack_with_proc to transform
+  #     flash[:notice].stack                # => "a simple string<br/>another" (default config uses <br/>),
+  #     flash[:notice] = ''                 # will overwrite everything above, and set back to empty string
+  #  end
+  #
+  #  StackableFlash.stacked({:stack_with_proc => Proc.new {|arr| arr.map! {|x| "<p>#{x}</p>"}.join } } ) do
+  #    flash[:error] = 'original'
+  #    flash[:error] << 'message'
+  #    flash[:error]        # => ['original','message']
+  #    # Uses the custom :stack_with_proc above to transform
+  #    flash[:error].stack  # => '<p>original</p><p>message</p>'
+  #  end
   #
   def self.stacked(config_options = {}, &block)
     flashing({:forcing => true}) do
@@ -35,9 +45,11 @@ module StackableFlash
   # 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] # => ''
+  #   flash[:notice] = 'a simple string'  # You can continue to use flash as if this gem did not exist
+  #   flash[:notice] << 'another'         # will concatenate the strings
+  #   flash[:notice]                      # => "a simple stringanother"
+  #   flash[:notice].stack                # => "a simple stringanother"
+  #   flash[:notice] = ''                 # will overwrite everything above, and set back to empty string
   # end
   #
   def self.not_stacked &block

data/lib/stackable_flash/flash_stack.rb

@@ -7,23 +7,26 @@ module StackableFlash
     #   flash[:notice] = 'First Part'
     #   flash[:notice] += ' Second Part'
     # => ['First Part Second Part']
-    define_method "+_with_stacking", lambda {|to_add|
+
+    def +(to_add)
       if StackableFlash.stacking
+
         if to_add.kind_of?(Array)
-          self.send("+_without_stacking", to_add)
+          super(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
+            self[self.length - 1] = self.last + to_add
           else
             self << to_add
           end
         end
+
       else
-        self.send("+_without_stacking", to_add)
+        super(to_add)
       end
-    }
-    alias_method_chain :+, :stacking
+    end
 
     def stack
       if StackableFlash.stacking

data/lib/stackable_flash/railtie.rb

@@ -16,7 +16,7 @@ module StackableFlash
         require 'action_controller'
         ActionController::Flash::FlashHash
       end
-      base.send :include, StackableFlash::StackLayer
+      base.send :prepend, StackableFlash::StackLayer
     end
 
   end

data/lib/stackable_flash/stack_layer.rb

@@ -2,27 +2,21 @@ require "stackable_flash/flash_stack"
 
 module StackableFlash
   module StackLayer
-    def self.included(base)
-      base.class_eval do
-        alias_method_chain :[]=, :stacking
-        alias_method_chain :[], :stacking
-      end
-    end
 
-    define_method "[]_with_stacking" do |key|
+    def [](key)
       if StackableFlash.stacking
         #Do it in a non-stacking block so we get normal behavior from flash[:notice] calls
         StackableFlash.not_stacked do
-          actual = send("[]_without_stacking", key)
+          actual = super(key)
           if actual.nil?
-            send("[]_with_stacking=", key, StackableFlash::FlashStack.new)
+            send(:[]=, key, StackableFlash::FlashStack.new)
           end
         end
       else
         # All StackableFlash functionality is completely bypassed
-        send("[]_without_stacking", key)
+        super(key)
       end
-      return send("[]_without_stacking", key)
+      return super(key)
     end
 
     # Make an array at the key, while providing a seamless upgrade to existing flashes
@@ -48,9 +42,9 @@ module StackableFlash
     #
     # The same line of code does all of the above.
     # Leave existing behavior in place, but send the full array as the value so it doesn't get killed.
-    define_method "[]_with_stacking=" do |key, value|
+    def []=(key, value)
       if StackableFlash.stacking
-        send("[]_without_stacking=", key,
+        super(key,
           StackableFlash::FlashStack.new.replace(
             value.kind_of?(Array) ?
               value :
@@ -60,7 +54,7 @@ module StackableFlash
         )
       else
         # All StackableFlash functionality is completely bypassed
-        send("[]_without_stacking=", key, value)
+        super(key, value)
       end
     end
 

data/lib/stackable_flash/test_helpers.rb

@@ -1,6 +1,7 @@
 module StackableFlash
   module TestHelpers
 
+    # slash is shorthand for stackable_flash
     def flash_in_stack(slash_for_status, expecting)
       return true if slash_for_status == expecting
       if slash_for_status.kind_of?(Array)

data/lib/stackable_flash/version.rb

@@ -1,3 +1,3 @@
 module StackableFlash
-  VERSION = "0.0.7"
+  VERSION = '0.1.1'
 end

data/spec/dummy/Rakefile

@@ -1,7 +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
+#!/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

@@ -1,15 +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 .
+// 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

@@ -1,13 +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 .
-*/
+/*
+ * 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

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

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

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

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

@@ -1,14 +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>
+<!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.ru

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

data/spec/dummy/config/application.rb

@@ -1,62 +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
-
+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
+