flash_helper 1.0.0 → 1.0.2

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [Nicolas Cavigneaux]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rubyforge'
+
+SPEC = Gem::Specification.new do |s|
+   s.name               = 'flash_helper'
+   s.version            = '1.0.2'
+   s.authors            = ['Nicolas Cavigneaux']
+   s.email              = 'nico@bounga.org'
+   s.homepage           = 'http://www.bitbucket.org/Bounga/flash-helper'
+   s.rubyforge_project  = %q{flash-helper}
+   s.summary            = 'Rails extension to handle flash messages'
+   s.description        = 'This Rails extension provides a simple way to handle flash messages. You can easily display notices, errors and warnings using the convinience method.'
+   s.files              = [ "Rakefile", "init.rb", "install.rb", "README", "LICENCE", "uninstall.rb" ] +
+                          Dir.glob("{bin,assets,doc,lib,tasks,test}/**/*")
+   s.test_file          = "test/flash_helper_test.rb"
+   s.has_rdoc           = true
+   s.extra_rdoc_files   = ['README']
+   s.require_paths      = ["lib"]
+   s.add_dependency('actionpack')
+end
+
+desc 'run unit tests'
+task :default => :test
+
+task :gem
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_bz2 = true
+end
+
+desc "Install gem file #{SPEC.name}-#{SPEC.version}.gem"
+task :install => [:gem] do
+  sh "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem"
+end
+
+desc "Publish documentation to RubyForge"
+task :publish_doc => [:rdoc] do
+  rf = Rake::RubyForgePublisher.new(SPEC.rubyforge_project, 'bounga')
+  rf.upload
+  puts "Published documentation to RubyForge"
+end
+
+desc "Release gem #{SPEC.name}-#{SPEC.version}.gem"
+task :release => [:gem, :publish_doc] do
+  rf = RubyForge.new.configure
+  puts "Logging in"
+  rf.login
+
+  puts "Releasing #{SPEC.name} v.#{SPEC.version}"
+
+  files = Dir.glob('pkg/*.{zip,bz2,gem}')
+  rf.add_release SPEC.rubyforge_project, SPEC.rubyforge_project, SPEC.version, *files
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.title    = 'FlashHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/assets/stylesheets/flash_helper.css

@@ -0,0 +1,48 @@
+.notice,.errors,.warning {
+padding: 5px 8px;
+margin: 0 0 10px 0;
+}
+.notice {
+background-color: #CFC;
+border: solid 1px #6C6;
+}
+.warning {
+background-color: #fcf100;
+border: solid 1px #ffc707;
+}
+.errors {
+background-color: #FCC;
+border: solid 1px #C66;
+}
+.fieldWithErrors {
+display: inline;
+}
+#errorExplanation {
+width: 400px;
+border: 2px solid #CF0000;
+padding: 0px;
+padding-bottom: 12px;
+margin-bottom: 20px;
+background-color: #f0f0f0;
+}
+#errorExplanation h2 {
+text-align: left;
+font-weight: bold;
+padding: 5px 5px 5px 15px;
+font-size: 12px;
+margin: 0px;
+background-color: #c00;
+color: #fff;
+}
+#errorExplanation p {
+color: #333;
+margin-bottom: 0;
+padding: 8px;
+}
+#errorExplanation ul {
+margin: 2px 24px;
+}
+#errorExplanation ul li {
+font-size: 12px;
+list-style: disc;
+}

data/init.rb

@@ -0,0 +1 @@
+require 'flash_helper'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/flash_helper.rb

@@ -0,0 +1,76 @@
+require 'active_support'
+
+module Bounga
+  module FlashHelper
+    # This extension provides a simple way to handle flash messages.
+    # You can easily display notices, errors and warnings using the convinience method.
+    #
+    # == Example
+    #
+    # For example, in your layout use :
+    #
+    #   display_flashes # Use defaults
+    #
+    # Then in your controllers you can use :
+    #   flash[:notice] = "Successfully created..."
+    #   flash[:errors] = "Creation failed!"
+    #   flash[:errors] = @news.errors
+    #   flash[:warning] = "The new user has no blog associated..."
+   
+    # == Global options for helpers
+    #
+    # Options for flash helpers are optional and get their default values from the
+    # <tt>Bounga::FlashHelper::ViewHelpers.flash_options</tt> hash. You can write to this hash to
+    # override default options on the global level:
+    #
+    #   Bounga::FlashHelper::ViewHelpers.flash_options[:notice_class] = 'my_notice'
+    #
+    # By putting this into "config/initializers/flash_helper.rb" (or simply environment.rb in
+    # older versions of Rails) you can easily override any default option.
+    module ViewHelpers
+      # default options that can be overridden on the global level
+      @@flash_options = {
+        :list_class     => 'errors_list',
+        :notice_class     => 'notice',
+        :errors_class     => 'errors',
+        :warning_class    => 'warning',
+        :default_message  => 'There are problems in your submission:'
+      }
+      mattr_reader :flash_options
+      
+      # Display flash messages.
+      # You can pass an optional string as a parameter. It will be display before
+      # error messages.
+      def display_flashes(message = @@flash_options[:default_message])
+        if flash[:notice]
+          flash_to_display, level = flash[:notice], @@flash_options[:notice_class]
+        elsif flash[:warning]
+          flash_to_display, level = flash[:warning], @@flash_options[:warning_class]
+        elsif flash[:errors]
+          level = @@flash_options[:errors_class]
+          if flash[:errors].instance_of? ActiveRecord::Errors
+            flash_to_display = message
+            flash_to_display << activerecord_error_list(flash[:errors])
+          else
+            flash_to_display = flash[:errors]
+          end
+        else
+          return
+        end
+        flash.discard(:notice); flash.discard(:warning); flash.discard(:errors)
+        content_tag 'div', flash_to_display, :class => "#{level}"
+      end 
+
+      
+      def activerecord_error_list(errors)
+        error_list = '<ul class="' + @@flash_options[:list_class] + '">'
+        error_list << errors.collect do |e, m|
+          "<li>#{e.humanize unless e == "base"} #{m}</li>"
+        end.to_s << '</ul>'
+        error_list
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, Bounga::FlashHelper::ViewHelpers

data/tasks/flash_helper_tasks.rake

@@ -0,0 +1,15 @@
+namespace :flash_helper do
+  PLUGIN_ROOT = File.dirname(__FILE__) + '/../'
+  
+  desc 'Install sample CSS file for flash messages.'
+  task :install do
+    FileUtils.cp Dir[PLUGIN_ROOT + '/assets/stylesheets/*.css'], RAILS_ROOT + '/public/stylesheets'
+    p "Flash messages stylesheet added."
+  end
+ 
+  desc 'Remove sample CSS file for flash messages..'
+  task :remove do
+    FileUtils.rm %{flash_helper.css}.collect { |f| RAILS_ROOT + "/public/stylesheets/" + f  }
+    p "Flash messages stylesheet deleted."
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flash_helper
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors: 
 - Nicolas Cavigneaux
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-05 00:00:00 +01:00
+date: 2008-12-08 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: This Rails extension provides a simple way to handle flash messages. You can easily display notices, errors and warnings using the convinience method.
 email: nico@bounga.org
 executables: []
@@ -22,7 +31,17 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- Rakefile
+- init.rb
+- install.rb
 - README
+- LICENCE
+- uninstall.rb
+- assets/stylesheets
+- assets/stylesheets/flash_helper.css
+- lib/flash_helper.rb
+- tasks/flash_helper_tasks.rake
+- test/flash_helper_test.rb
 has_rdoc: true
 homepage: http://www.bitbucket.org/Bounga/flash-helper
 post_install_message: