padrino-flash 0.1.2 → 0.2.0

data/lib/padrino-flash/storage.rb

@@ -13,12 +13,29 @@ module Padrino
         @next = {}
       end
 
+      ###
+      # Returns the specified flash message
+      #
+      # @return [String]
+      #   Flash message
+      #
+      # @example
+      #   flash[:notice]
+      #   # => 'Invalid login/password combination'
+      #
       # @since 0.1.0
       # @api public
       def [](type)
         @now[type]
       end
 
+      ###
+      # Sets the specified flash message
+      #
+      # @example
+      #   flash[:notice] = 'Invalid login/password combination'
+      #   flash[:notice] = :invalid_login
+      #
       # @since 0.1.0
       # @api public
       def []=(type, message)
@@ -26,25 +43,63 @@ module Padrino
         @next[type] = message
       end
 
+      ###
+      # Deletes the specified flash message
+      #
+      # @return [String]
+      #   Value of the deleted flash message
+      #
+      # @example
+      #   flash.delete :notice
+      #
       # @since 0.1.0
       # @api public
       def delete(type)
         @now.delete(type)
-        self
       end
 
+      ###
+      # Returns an array of flashes that have been set
+      #
+      # @return [Array<Symbol>]
+      #   Flashes set
+      #
+      # @example
+      #   flash.keys
+      #   # => [:notice]
+      #
       # @since 0.1.0
       # @api public
       def keys
         @now.keys
       end
 
+      ###
+      # Returns whether or not the specified flash is set
+      #
+      # @return [Boolean]
+      #   *true* if it is, *false* otherwise
+      #
+      # @example
+      #   flash.key?(:notice)
+      #   # => true
+      #
       # @since 0.1.0
       # @api public
       def key?(type)
         @now.key?(type)
       end
+      alias_method :has_key?, :key?
+      alias_method :include?, :key?
 
+      ###
+      # Iterates through set flashes
+      #
+      # @example
+      #   flash.each do |type, message|
+      #     # ...
+      #   end
+      #
       # @since 0.1.0
       # @api public
       def each(&block)
@@ -67,13 +122,20 @@ module Padrino
       alias_method :merge!, :update
 
       # @since 0.1.0
-      # @api public
+      # @api private
       def sweep
         @now.replace(@next)
         @next = {}
         self
       end
 
+      ###
+      # Keeps the specified flash for the next request
+      #
+      # @example
+      #   flash.keep :notice
+      #   flash.keep
+      #
       # @since 0.1.0
       # @api public
       def keep(key = nil)
@@ -84,6 +146,13 @@ module Padrino
         end
       end
 
+      ###
+      # Discards the specified flash so it doesn't show up on the next request
+      #
+      # @example
+      #   flash.discard :notice
+      #   flash.discard
+      #
       # @since 0.1.0
       # @api public
       def discard(key = nil)
@@ -94,12 +163,28 @@ module Padrino
         end
       end
 
+      ###
+      # Deletes all flashes that are currently set
+      #
+      # @example
+      #   flash.clear
+      #
       # @since 0.1.0
       # @api public
       def clear
         @now.clear
       end
 
+      ###
+      # Returns whether or not any flashes have been set
+      #
+      # @return [Boolean]
+      #   *true* if flashes are set, *false* otherwise
+      #
+      # @example
+      #   flash.empty?
+      #   # => true
+      #
       # @since 0.1.0
       # @api public
       def empty?
@@ -118,36 +203,84 @@ module Padrino
         @now.to_s
       end
 
+      ###
+      # Writer for the flash trinity :error (red)
+      #
+      # @example
+      #   flash.error = 'Something really bad happened here'
+      #
       # @since 0.1.0
       # @api public
       def error=(message)
         self[:error] = message
       end
 
+      ###
+      # Reader for the flash trinity :error (red)
+      #
+      # @return [String]
+      #   Flash message
+      #
+      # @example
+      #   flash.error
+      #   # => 'Something really bad happened here'
+      #
       # @since 0.1.0
       # @api public
       def error
         self[:error]
       end
 
+      ###
+      # Writer for the flash trinity :notice (yellow)
+      #
+      # @example
+      #   flash.notice = 'Something that needs your attention happened here'
+      #
       # @since 0.1.0
       # @api public
       def notice=(message)
         self[:notice] = message
       end
 
+      ###
+      # Reader for the flash trinity :notice (yellow)
+      #
+      # @return [String]
+      #   Flash message
+      #
+      # @example
+      #   flash.notice
+      #   # => 'Something that needs your attention happened here'
+      #
       # @since 0.1.0
       # @api public
       def notice
         self[:notice]
       end
 
+      ###
+      # Writer for the flash trinity :success (green)
+      #
+      # @example
+      #   flash.success = 'Something good happened here'
+      #
       # @since 0.1.0
       # @api public
       def success=(message)
         self[:success] = message
       end
 
+      ###
+      # Reader for the flash trinity :success (green)
+      #
+      # @return [String]
+      #   Flash message
+      #
+      # @example
+      #   flash.success
+      #   # => 'Something good happened here'
+      #
       # @since 0.1.0
       # @api public
       def success

data/lib/padrino-flash/version.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 module Padrino
   module Flash
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end # Flash
 end # Padrino

data/spec/storage_spec.rb

@@ -10,11 +10,16 @@ describe Padrino::Flash::Storage do
     flash[:two] = 'Two'
   end
 
-  it 'can delete a single flash' do
-    flash[:notice].should == 'Flash Notice'
-    flash.delete :notice
-    flash.key?(:notice).should be_false
-    flash[:notice].should be_nil
+  context :delete do
+    it 'should remove the message from the storage hash' do
+      flash[:notice].should == 'Flash Notice'
+      flash.delete :notice
+      flash.key?(:notice).should be_false
+    end
+
+    it 'should return the value of the deleted flash' do
+      flash.delete(:notice).should == 'Flash Notice'
+    end
   end
 
   it 'can delete the entire flash' do
@@ -25,15 +30,17 @@ describe Padrino::Flash::Storage do
     flash[:success].should be_nil
   end
 
-  it 'should set future flash messages' do
-    flash[:future] = 'Test'
-    flash[:future].should be_nil
-    flash.next[:future].should == 'Test'
-  end
+  context :[]= do
+    it 'should localize flash messages when a :symbol is used' do
+      flash[:localized] = :redirected
+      flash.next[:localized].should == 'Redirected'
+    end
 
-  it 'should localize flash messages when a :symbol is used' do
-    flash[:localized] = :redirected
-    flash.next[:localized].should == 'Redirected'
+    it 'should set future flash messages' do
+      flash[:future] = 'Test'
+      flash[:future].should be_nil
+      flash.next[:future].should == 'Test'
+    end
   end
 
   it 'should allow you to set the present flash' do
@@ -68,13 +75,23 @@ describe Padrino::Flash::Storage do
     flash[:success].should_not == 'Flash Success'
   end
 
-  it 'can iterate through flash messages' do
-    flashes = []
-    flash.each do |type, message|
-      flashes << [type, message]
+  context :each do
+    it 'can iterate through flash messages' do
+      flashes = []
+      flash.each do |type, message|
+        flashes << [type, message]
+      end
+      flashes[0].should == [:notice, 'Flash Notice']
+      flashes[1].should == [:success, 'Flash Success']
+    end
+
+    it 'should allow enumeration' do
+      flashes = flash.collect do |type, message|
+        [type, message]
+      end
+      flashes[0].should == [:notice, 'Flash Notice']
+      flashes[1].should == [:success, 'Flash Success']
     end
-    flashes[0].should == [:notice, 'Flash Notice']
-    flashes[1].should == [:success, 'Flash Success']
   end
 
   it 'can sweep up the old to make room for the new' do
@@ -92,13 +109,30 @@ describe Padrino::Flash::Storage do
     flash[:error].should == 'Replaced'
   end
 
-  it 'can return the existing flash keys' do
-    flash.keys.should == [:notice, :success]
+  context :keys do
+    it 'can return the existing flash keys' do
+      flash.keys.should == [:notice, :success]
+    end
+
+    it 'should return an empty array when no flashes are set' do
+      flash.clear
+      flash.keys.should == []
+    end
   end
 
-  it 'can tell you if a key is set' do
-    flash.key?(:notice).should be_true
-    flash.key?(:one).should be_false
+  context :key? do
+    it 'should return true when a flash is set' do
+      flash.key?(:notice).should be_true
+    end
+
+    it 'should return false when a flash is not set' do
+      flash.key?(:non_existent).should be_false
+    end
+
+    it 'should not read future flash messages' do
+      flash[:future] = 'Future'
+      flash.key?(:future).should be_false
+    end
   end
 
   it 'can merge flash messages' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: padrino-flash
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000 Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: padrino-core
-  requirement: &15649596 !ruby/object:Gem::Requirement
+  requirement: &15597876 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15649596
+  version_requirements: *15597876
 - !ruby/object:Gem::Dependency
   name: padrino-helpers
-  requirement: &15649284 !ruby/object:Gem::Requirement
+  requirement: &15597504 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15649284
+  version_requirements: *15597504
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15648936 !ruby/object:Gem::Requirement
+  requirement: &15597144 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *15648936
+  version_requirements: *15597144
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
-  requirement: &15648624 !ruby/object:Gem::Requirement
+  requirement: &15596724 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15648624
+  version_requirements: *15596724
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &15648288 !ruby/object:Gem::Requirement
+  requirement: &15596352 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15648288
+  version_requirements: *15596352
 description: A plugin for the Padrino web framework which adds support for Rails like
   flash messages
 email: