flushing-flash 0.2.3 → 0.3.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@gem-flushing-flash --create

data/README.rdoc

@@ -8,75 +8,90 @@ To provide helper methods for handling rails flash messages.
 
 Put the following into the Gemfile and run `bundle install`
 
-    gem 'flushing_flash'
+  gem 'flushing_flash'
 
 == Usage
     
-==== to push a flash message
+==== 1. To push a flash message
 
-    push_flash(message_type, *args)
+  push_flash(message_type, *args)
 
-==== examples:
+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.
+  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
+=== 2. To pull flash messages from a target
 
-    pull_flash(target=:default)
+  pull_flash(target=:default)
 
-==== examples:
+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: ...}, ...]
+  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
+=== 3. To check if a target has flash messages or not
 
-    has_flash?(target=:default)
+  has_flash?(target=:default)
 
-==== examples:
+examples:
 
-    3.1) has_flash?
-      true / false
-    
-    3.2) has_flash?(:signin_form)
-      true / false
+  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
+=== 4. To 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)
+  flush_flash(target=:default)
 
-==== examples:
+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>
+  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>
+
+=== 5. To use self-defined partial for rendering the flash messages
+
+  flush_flash(target=:default, options={})
+
+examples:
+
+  5.1 flush_flash(using: "shared/flash_messages")
+    HTML output for the partial app/views/shared/_flash_messages.html.erb
+  
+=== Change Logs
+
+==== 0.2.3
+
+1. fixed error if passing `:using` to pull `flush_flash` method. Now you could make use of `:using` option to use your own partial for rendering the flash messages.

data/Rakefile

@@ -1,13 +1,13 @@
 # encoding: utf-8
 
 # Process of development:
-#   1. do the actual coding and update (hopfully with tests)
-#   2. commit
-#   3. goto 1 if needed :) else goto 4
-#   4. update the version in lib/flushing-flash/version.rb
-#   5. git commit -am "bump version to 0.1.0" # please update the version number
+#   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
+#   7. rake release # will be automatically git tagged!!!
 
 require 'rubygems'
 require 'bundler'

data/flushing-flash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flushing-flash}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{PeterWong}]
-  s.date = %q{2011-11-04}
+  s.date = %q{2011-11-05}
   s.description = %q{To provide helper methods for handling rails flash messages.}
   s.email = %q{peter@peterwongpp.com}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -28,6 +29,72 @@ Gem::Specification.new do |s|
     "lib/flushing-flash/action_controller_methods.rb",
     "lib/flushing-flash/action_view_methods.rb",
     "lib/flushing-flash/version.rb",
+    "test/dummy/.gitignore",
+    "test/dummy/Gemfile",
+    "test/dummy/Gemfile.lock",
+    "test/dummy/README",
+    "test/dummy/Rakefile",
+    "test/dummy/app/assets/images/rails.png",
+    "test/dummy/app/assets/javascripts/application.js",
+    "test/dummy/app/assets/javascripts/posts.js.coffee",
+    "test/dummy/app/assets/stylesheets/application.css",
+    "test/dummy/app/assets/stylesheets/posts.css.scss",
+    "test/dummy/app/assets/stylesheets/scaffolds.css.scss",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/controllers/posts_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/helpers/posts_helper.rb",
+    "test/dummy/app/mailers/.gitkeep",
+    "test/dummy/app/models/.gitkeep",
+    "test/dummy/app/models/post.rb",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/app/views/posts/_form.html.erb",
+    "test/dummy/app/views/posts/edit.html.erb",
+    "test/dummy/app/views/posts/index.html.erb",
+    "test/dummy/app/views/posts/new.html.erb",
+    "test/dummy/app/views/posts/show.html.erb",
+    "test/dummy/app/views/shared/_flash_messages.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wrap_parameters.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/db/migrate/20111105100343_create_posts.rb",
+    "test/dummy/db/schema.rb",
+    "test/dummy/db/seeds.rb",
+    "test/dummy/lib/assets/.gitkeep",
+    "test/dummy/lib/tasks/.gitkeep",
+    "test/dummy/log/.gitkeep",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/public/index.html",
+    "test/dummy/public/robots.txt",
+    "test/dummy/script/rails",
+    "test/dummy/test/fixtures/.gitkeep",
+    "test/dummy/test/fixtures/posts.yml",
+    "test/dummy/test/functional/.gitkeep",
+    "test/dummy/test/functional/posts_controller_test.rb",
+    "test/dummy/test/integration/.gitkeep",
+    "test/dummy/test/performance/browsing_test.rb",
+    "test/dummy/test/test_helper.rb",
+    "test/dummy/test/unit/.gitkeep",
+    "test/dummy/test/unit/helpers/posts_helper_test.rb",
+    "test/dummy/test/unit/post_test.rb",
+    "test/dummy/vendor/assets/stylesheets/.gitkeep",
+    "test/dummy/vendor/plugins/.gitkeep",
     "test/helper.rb",
     "test/test_flushing-flash.rb"
   ]

data/lib/flushing-flash/action_view_methods.rb

@@ -15,16 +15,16 @@ module FlushingFlash
       
       def flush_flash(target=:default, options={})
         msgs = pull_flash(target)
-        using_template = options[:using]
+        using_template = options[:using] || nil
+        html_safe = options[:html_safe] || false
         
         if msgs.any?
           if using_template
             render partial: 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)
+              content_tag :div, class: "flash-message #{msg[:message_type]}" do
+                concat content_tag(:p, (html_safe ? msg[:content].html_safe : msg[:content]))
               end
             end.join.html_safe
           end

data/lib/flushing-flash/version.rb

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

data/test/dummy/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/test/dummy/Gemfile

@@ -0,0 +1,38 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.1'
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.1.4'
+  gem 'coffee-rails', '~> 3.1.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+group :test do
+  # Pretty printed test output
+  gem 'turn', :require => false
+end
+
+gem 'flushing-flash'

data/test/dummy/Gemfile.lock

@@ -0,0 +1,121 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    ansi (1.3.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    coffee-rails (3.1.1)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.1.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.2)
+    erubis (2.7.0)
+    execjs (1.2.9)
+      multi_json (~> 1.0)
+    flushing-flash (0.3.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jquery-rails (1.0.16)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    json (1.6.1)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.3)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
+      bundler (~> 1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    sass (3.1.10)
+    sass-rails (3.1.4)
+      actionpack (~> 3.1.0)
+      railties (~> 3.1.0)
+      sass (>= 3.1.4)
+      sprockets (~> 2.0.0)
+      tilt (~> 1.3.2)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    turn (0.8.3)
+      ansi
+    tzinfo (0.3.30)
+    uglifier (1.0.4)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 3.1.1)
+  flushing-flash
+  jquery-rails
+  rails (= 3.1.1)
+  sass-rails (~> 3.1.4)
+  sqlite3
+  turn
+  uglifier (>= 1.0.3)