flushing-flash 0.2.0 → 0.2.1

data/README.rdoc

@@ -1,19 +1,82 @@
-= flushing-flash
+= Flushing Flash
 
-Description goes here.
+To provide helper methods for handling rails flash messages.
 
-== Contributing to flushing-flash
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+== Installation
 
-== Copyright
+=== Rails 3.0
 
-Copyright (c) 2011 PeterWong. See LICENSE.txt for
-further details.
+Put the following into the Gemfile and run `bundle install`
 
+    gem 'flushing_flash'
+
+== Usage
+    
+==== to push a flash message
+
+    push_flash(message_type, *args)
+
+==== examples:
+
+    1.1) push_flash(:success)
+      { message_type: :success, content: I18n.t("flashes.#{controller_name}.#{action_name}.success", {}) }
+    
+    1.2) push_flash(:failure, "User is not authenticated!") # note that the 2nd param is a **String**!
+      { message_type: :failure, content: "User is not authenticated!" }
+    
+    1.3) push_flash(:failure, :"users.authenticate") # note that the 2nd param is a **Symbol**!
+      { message_type: :failure, content: I18n.t("flashes.users.authenticate.failure", {}) }
+    
+    1.4) push_flash(:success, name: "Peter")
+      { message_type: :success, content: I18n.t("flashes.#{controller_name}.#{action_name}.success", name: "Peter") }
+    
+    1.5) push_flash(:failure, :"users.authenticate", name: "Peter")
+      { message_type: :success, content: I18nt("flashes.users.authenticate.failure", name: "Peter") }
+    
+    1.6) push_flash(:success, name: "Peter", target: :signin_form)
+      the target will not be passed to the I18n.t! Instead, it is a keyword for identifying the target receving the message.
+      see the (2) part.
+
+=== to pull flash messages from a target
+
+    pull_flash(target=:default)
+
+==== examples:
+
+    2.1) pull_flash # pull from :default target
+      [{message_type: ..., content: ...}, { message_type: ..., content: ...}, ...]
+    
+    2.2) pull_flash(:signin_form)
+      [{message_type: ..., content: ...}, { message_type: ..., content: ...}, ...]
+
+=== check if a target has flash messages or not
+
+    has_flash?(target=:default)
+
+==== examples:
+
+    3.1) has_flash?
+      true / false
+    
+    3.2) has_flash?(:signin_form)
+      true / false
+
+=== return currently hard-coded view for the messages in the target
+
+*** TODO: provide a better way to customize the html output ***
+
+    flush_flash(target=:default)
+
+==== examples:
+
+    4.1) flush_flash
+      <div class="alert-message #{message_type} fade in">
+        <a href="#" class="close">x</a>
+        <p>#{content.html_safe}</p>
+      </div>
+    
+    4.2) flush_flash(:signin_form)
+      <div class="alert-message #{message_type} fade in">
+        <a href="#" class="close">x</a>
+        <p>#{content.html_safe}</p>
+      </div>

data/Rakefile

@@ -1,5 +1,14 @@
 # encoding: utf-8
 
+# Process of development:
+#   1. update the version in lib/flushing-flash/version.rb
+#   2. git commit -am "bump version to 0.1.0" # please update the version number
+#   3. do the actual coding and update (hopfully with tests)
+#   4. commit
+#   5. goto 3 if needed :) else goto 6
+#   6. rake install to install locally (and hopfully test it with test applications)
+#   7. rake release
+
 require 'rubygems'
 require 'bundler'
 begin

data/flushing-flash.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flushing-flash}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{PeterWong}]
@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "flushing-flash.gemspec",
     "lib/flushing-flash.rb",
+    "lib/flushing-flash/action_controller_methods.rb",
+    "lib/flushing-flash/action_view_methods.rb",
     "lib/flushing-flash/version.rb",
     "test/helper.rb",
     "test/test_flushing-flash.rb"

data/lib/flushing-flash/action_controller_methods.rb

@@ -0,0 +1,45 @@
+module FlushingFlash
+  module ActionControllerMethods
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+      base.send(:helper_method, :pull_flash)
+    end
+    
+    module ClassMethods
+    end
+    
+    module InstanceMethods
+      def push_flash(message_type, *args)
+        opts = args.extract_options!
+
+        i18n_options = opts.delete(:i18n_options)
+        target = opts.delete(:target) || :default
+
+        flash_content = case args[0].class.name
+        when String.name
+          args[0]
+        when Symbol.name
+          I18n.t("flashes.#{args[0]}.#{message_type}", i18n_options)
+        else
+          I18n.t("flashes.#{self.class.name.gsub(/Controller$/, "").underscore.gsub(/\//, ".")}.#{action_name.underscore}.#{message_type}", i18n_options)
+        end
+
+        flash[target] ||= []
+        flash[target] << { message_type: message_type, content: flash_content }
+      end
+    
+      def pull_flash(target=:default)
+        @pulled_flashes ||= {}
+        return @pulled_flashes[target] if @pulled_flashes[target]
+
+        @pulled_flashes[target] = flash[target] || []
+        flash.delete(target)
+
+        @pulled_flashes[target]
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, FlushingFlash::ActionControllerMethods

data/lib/flushing-flash/action_view_methods.rb

@@ -0,0 +1,37 @@
+module FlushingFlash
+  module ActionViewMethods
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module ClassMethods
+    end
+    
+    module InstanceMethods
+      def has_flash?(target=:default)
+        pull_flash(target).any?
+      end
+      
+      def flush_flash(target=:default, options={})
+        msgs = pull_flash(target)
+        using_template = options[:using]
+        
+        if msgs.any?
+          if using_template
+            render using_template, locals: { messages: msgs }
+          else
+            msgs.collect do |msg|
+              content_tag :div, class: "alert-message #{msg[:message_type]} fade in" do
+                concat link_to("x", "#", class: "close")
+                concat content_tag(:p, msg[:content].html_safe)
+              end
+            end.join.html_safe
+          end
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, FlushingFlash::ActionViewMethods

data/lib/flushing-flash/version.rb

@@ -1,8 +1,8 @@
 module FlushingFlash
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 0
+    MINOR = 2
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/flushing-flash.rb

@@ -0,0 +1,3 @@
+require 'flushing_flash/version'
+require 'flushing_flash/action_controller_methods'
+require 'flushing_flash/action_view_methods'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flushing-flash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70354756592760 !ruby/object:Gem::Requirement
+  requirement: &70334196290160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70354756592760
+  version_requirements: *70334196290160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70354756589880 !ruby/object:Gem::Requirement
+  requirement: &70334196288260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70354756589880
+  version_requirements: *70334196288260
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70354756587220 !ruby/object:Gem::Requirement
+  requirement: &70334196276420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70354756587220
+  version_requirements: *70334196276420
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70354756584160 !ruby/object:Gem::Requirement
+  requirement: &70334196273840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70354756584160
+  version_requirements: *70334196273840
 description: To provide helper methods for handling rails flash messages.
 email: peter@peterwongpp.com
 executables: []
@@ -71,6 +71,8 @@ files:
 - Rakefile
 - flushing-flash.gemspec
 - lib/flushing-flash.rb
+- lib/flushing-flash/action_controller_methods.rb
+- lib/flushing-flash/action_view_methods.rb
 - lib/flushing-flash/version.rb
 - test/helper.rb
 - test/test_flushing-flash.rb
@@ -89,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3492364780556368960
+      hash: 4112173491818456181
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: