stackable_flash 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,13 @@
+Version 0.0.5 - AUG.22.2012
+- Added Rspec Matchers and Test::Unit helpers.
+
+Version 0.0.4 - AUG.21.2012
+- Refactoring
+- Added ability to cold boot a flash so you can call flash[:notice] << 'Hello' without initializing it first
+
+Version 0.0.3 - AUG.20.2012
+- Switch to proper Railtie
+
 Version 0.0.2 - AUG.18.2012
 - Added rake dependency
 - Expanded README

data/README.md

@@ -3,7 +3,7 @@ stackable_flash
 
 Allows flashes to stack intelligently, while preserving existing behavior of Rails' FlashHash.
 
-Stackable Flash overrides the :[]= method of Rails' FlashHash with the result being that each flash key is an array.
+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.
 Only now you can push things onto the array with `:<<`, and generally interact with the flash as an array.
 In order to be as compatible as possible with existing implementations of the FlashHash on websites, `:[]=` will still
@@ -109,8 +109,8 @@ 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
 
-== Copyright
+## Copyright
 
 Licensed under the MIT License.
 
-- Copyright (c) 2012 Peter H. Boling (http://peterboling.com). See LICENSE for further details.
+* Copyright (c) 2012 Peter H. Boling (http://peterboling.com). See LICENSE for further details.

data/lib/stackable_flash/rspec_matchers.rb

@@ -0,0 +1,21 @@
+require 'stackable_flash/test_helpers'
+
+module StackableFlash
+  module RspecMatchers
+    include StackableFlash::TestHelpers
+    RSpec::Matchers.define :have_stackable_flash do |expecting|
+      define_method :has_stackable_flash? do |slash|
+        flash_in_stack(slash, expecting)
+      end
+
+      match{|slash| has_stackable_flash?(slash)}
+
+      failure_message_for_should do |slash|
+        "expected flash to be or include #{expected.inspect}, but got #{slash}"
+      end
+      failure_message_for_should_not do |slash|
+        "expected flash to not be and not include #{expected.inspect}, but got #{slash}"
+      end
+    end
+  end
+end

data/lib/stackable_flash/test_helpers.rb

@@ -0,0 +1,15 @@
+module StackableFlash
+  module TestHelpers
+
+    def flash_in_stack(slash_for_status, expecting)
+      return true if slash_for_status == expecting
+      if slash_for_status.kind_of?(Array)
+        matches = slash_for_status.select do |to_check|
+          to_check == expecting
+        end
+        return matches.length > 0
+      end
+    end
+
+  end
+end

data/lib/stackable_flash/version.rb

@@ -1,3 +1,3 @@
 module StackableFlash
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require File.expand_path("../dummy/config/environment",  __FILE__)
 
 require 'rspec/rails'
 require 'stackable_flash'
+require 'stackable_flash/rspec_matchers'
 
 ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
 
@@ -22,4 +23,6 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 
+  config.include StackableFlash::RspecMatchers
+
 end

data/spec/stackable_flash/rspec_matchers_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+
+describe StackableFlash::StackLayer do
+  before(:each) do
+    @flash = ActionDispatch::Flash::FlashHash.new
+  end
+  describe "tests against strange things" do
+    context "should" do
+      it "should be able to test against odd values like an Object.new" do
+        lambda {@flash[:notice].should have_stackable_flash(Object.new)}.should raise_error RSpec::Expectations::ExpectationNotMetError
+      end
+      it "should be able to test against odd values like {:hello => 'asdf'}" do
+        lambda {@flash[:notice].should have_stackable_flash({:hello => 'asdf'})}.should raise_error RSpec::Expectations::ExpectationNotMetError
+      end
+    end
+    context "should_not" do
+      it "should be able to test against odd values like an Object.new" do
+        lambda {@flash[:notice].should_not have_stackable_flash(Object.new)}.should_not raise_exception
+      end
+      it "should be able to test against odd values like {:hello => 'asdf'}" do
+        lambda {@flash[:notice].should_not have_stackable_flash({:hello => 'asdf'})}.should_not raise_exception
+      end
+    end
+  end
+
+  describe "have_stackable_flash after using :[]=" do
+    context "a string" do
+      context "when there is not an existing flash message" do
+        context "sets the flash message" do
+          before(:each) do
+            @flash[:notice] = 'message'
+          end
+          it "should match the value itself" do
+            @flash[:notice].should have_stackable_flash('message')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash(['message'])
+          end
+        end
+      end
+      context "when there is an existing flash message" do
+        context "overwrite the original string" do
+          before(:each) do
+            @flash[:notice] = 'original'
+            @flash[:notice] = ''
+          end
+          it "should match the value itself" do
+            @flash[:notice].should have_stackable_flash('')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash([''])
+          end
+        end
+        context "overwrite the original array" do
+          before(:each) do
+            @flash[:notice] = ['original']
+            @flash[:notice] = ''
+          end
+          it "should match the value itself" do
+            @flash[:notice].should_not have_stackable_flash('original')
+            @flash[:notice].should_not have_stackable_flash(['original'])
+            @flash[:notice].should have_stackable_flash('')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash([''])
+          end
+        end
+      end
+    end
+    context "an array" do
+      context "when there is not an existing flash message" do
+        context "sets the flash message" do
+          before(:each) do
+            @flash[:notice] = ['message']
+          end
+          it "should match the value itself" do
+            @flash[:notice].should have_stackable_flash('message')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash(['message'])
+          end
+        end
+      end
+      context "when there is an existing flash message" do
+        context "overwrite the original string" do
+          before(:each) do
+            @flash[:notice] = 'original'
+            @flash[:notice] = ['message']
+          end
+          it "should match the value itself" do
+            @flash[:notice].should_not have_stackable_flash('original')
+            @flash[:notice].should have_stackable_flash('message')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash(['message'])
+          end
+        end
+        context "overwrite the original array" do
+          before(:each) do
+            @flash[:notice] = ['original']
+            @flash[:notice] = ['message']
+          end
+          it "should match the value itself" do
+            @flash[:notice].should_not have_stackable_flash(['original'])
+            @flash[:notice].should_not have_stackable_flash('original')
+            @flash[:notice].should have_stackable_flash('message')
+          end
+          it "should match the entire array" do
+            @flash[:notice].should have_stackable_flash(['message'])
+          end
+        end
+      end
+    end
+  end
+  # Actually testing how it interacts with Array's :<< method
+  describe "have_stackable_flash after using :<<" do
+    context "a string" do
+      context "should build a stack" do
+        before(:each) do
+          @flash[:notice] = 'original'
+          @flash[:notice] << 'message'
+        end
+        it "should match the value itself" do
+          @flash[:notice].should have_stackable_flash('original')
+          @flash[:notice].should have_stackable_flash('message')
+        end
+        it "should match the entire array" do
+          @flash[:notice].should have_stackable_flash(['original','message'])
+        end
+      end
+    end
+    context "an array" do
+      context "should build a stack" do
+        before(:each) do
+          @flash[:notice] = ['original']
+          @flash[:notice] << 'message'
+        end
+        it "should match the value itself" do
+          @flash[:notice].should_not have_stackable_flash(['original'])
+          @flash[:notice].should have_stackable_flash('original')
+          @flash[:notice].should have_stackable_flash('message')
+        end
+        it "should match the entire array" do
+          @flash[:notice].should have_stackable_flash(['original','message'])
+        end
+      end
+      context "should allow any data type" do
+        before(:each) do
+          @flash[:notice] = ['original']
+          @flash[:notice] << ['nested']
+          @flash[:notice] << 123
+        end
+        it "should match the value itself" do
+          @flash[:notice].should have_stackable_flash('original')
+          @flash[:notice].should_not have_stackable_flash(['original'])
+          @flash[:notice].should have_stackable_flash(['nested'])
+          @flash[:notice].should_not have_stackable_flash('nested')
+          @flash[:notice].should have_stackable_flash(123)
+        end
+        it "should match the entire array" do
+          @flash[:notice].should have_stackable_flash(['original',['nested'],123])
+        end
+      end
+    end
+  end
+
+  describe "mixed use" do
+    after(:each) do
+      StackableFlash.stacking = true
+    end
+    context "when StackableFlash is turned off and on" do
+      it "should not fail for strings" do
+        StackableFlash.stacking = false
+        @flash[:notice] = 'original'
+        StackableFlash.stacking = true
+        @flash[:notice] << 'message'
+        @flash[:notice].should have_stackable_flash('originalmessage')
+      end
+      it "should not fail for an array" do
+        StackableFlash.stacking = false
+        @flash[:notice] = ['original']
+        StackableFlash.stacking = true
+        @flash[:notice] << 'message'
+        @flash[:notice].should have_stackable_flash('original')
+        @flash[:notice].should have_stackable_flash('message')
+        @flash[:notice].should have_stackable_flash(['original','message'])
+      end
+    end
+    context "when StackableFlash is turned on and off" do
+      it "should not fail for strings" do
+        StackableFlash.stacking = true
+        @flash[:notice] = 'original'
+        StackableFlash.stacking = false
+        @flash[:notice] << 'message'
+        @flash[:notice].should have_stackable_flash('original')
+        @flash[:notice].should have_stackable_flash('message')
+        @flash[:notice].should have_stackable_flash(['original','message'])
+      end
+    end
+  end
+
+  describe "when stackable_flash is off" do
+    context "StackableFlash.not_stacked" do
+      it "should not fail for strings" do
+        StackableFlash.not_stacked do
+          @flash[:notice] = 'original'
+          @flash[:notice] << 'message'
+          @flash[:notice].should have_stackable_flash('originalmessage')
+          @flash[:notice].should_not have_stackable_flash('original')
+          @flash[:notice].should_not have_stackable_flash('message')
+          @flash[:notice].should_not have_stackable_flash(['original','message'])
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackable_flash
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -126,7 +126,9 @@ files:
 - lib/stackable_flash/config.rb
 - lib/stackable_flash/flash_stack.rb
 - lib/stackable_flash/railtie.rb
+- lib/stackable_flash/rspec_matchers.rb
 - lib/stackable_flash/stack_layer.rb
+- lib/stackable_flash/test_helpers.rb
 - lib/stackable_flash/version.rb
 - spec/controllers/dummy_controller_spec.rb
 - spec/dummy/Rakefile
@@ -165,6 +167,7 @@ files:
 - spec/dummy/script/rails
 - spec/spec_helper.rb
 - spec/stackable_flash/flash_stack_spec.rb
+- spec/stackable_flash/rspec_matchers_spec.rb
 - stackable_flash.gemspec
 homepage: https://github.com/pboling/stackable_flash
 licenses: []
@@ -228,3 +231,4 @@ test_files:
 - spec/dummy/script/rails
 - spec/spec_helper.rb
 - spec/stackable_flash/flash_stack_spec.rb
+- spec/stackable_flash/rspec_matchers_spec.rb