railsgarden-message_block 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+* [0.1.0] Initial Version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Hughes
+
+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/README.rdoc

@@ -0,0 +1,59 @@
+== Message Block
+
+Implements the common view pattern by which a list of messages are shown at the top, 
+often a combination of flash messages and ActiveRecord validation issues on one or more models.  
+This allows for a nice, stylized block of messages at the top of the page with icons 
+indicating what type of message it is (error, confirmation, warning, etc.)
+
+This view helper acts as a replacement for error_messages_for by taking error messages 
+from your models and combing them with flash messages (multiple types such as error, confirm, etc.) 
+and outputting them to your view.  This plugin comes with an example stylesheet and images.
+
+== Usage
+
+Once you install this, you should now have a set of images at public/images/message_block and 
+a basic stylesheet installed at public/stylesheets/message_block.css.  First you'll want to either 
+reference this in your layout or copy the declarations to your main layout.  Then you can use 
+the helper <tt><%= message_block %></tt> as described below:
+
+The first argument specifies a hash options:
+
+* <tt>:on</tt> - specifies one or many model names for which to check error messages.
+* <tt>:model_error_type</tt> - specifies the message type to use for validation errors; defaults to 'error'
+* <tt>:flash_types</tt> - specifies the keys to check in the flash hash.  Messages will be grouped in ul 
+  lists according to this type.  Defaults to: %w(back confirm error info warn)
+* <tt>:html</tt> - Specifies HTML options for the containing div
+* <tt>:id</tt> - Specifies ID of the containing div; defaults to 'message_block'
+* <tt>:class</tt> - Specifies class name of the containing div; defaults to nothing.
+
+=== Example
+Imagine you have a form for entering a user and a comment:
+
+  <%= message_block :on => [:user, :comment] %>
+
+Imagine also you set these flash variables in the controller:
+  class CommentsController
+    def create
+      flash.now[:error] = "Error A"
+      flash.now[:confirm] = "Confirmation A"  # Note you can use different types
+      flash.now[:warn] = ["Warn A", "Warn B"]  # Can set to an array for multiple messages
+    end
+  end
+
+And let's say that you want to show these messages but also show the validation issues 
+given that both user and comment fail ActiveRecord validation:
+
+  <div id="message_block">
+    <ul class="error">
+      <li>Error A</li>
+      <li>User first name is required.</li>
+      <li>Comment contents is required.</li>
+    </ul>
+    <ul class="confirm">
+      <li>Confirmation A</li>
+    </ul>
+    <ul class="warn">
+      <li>Warn A</li>
+      <li>Warn B</li>
+    </ul>
+  </div>

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'echoe'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the message_block plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the message_block plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MessageBlock'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Echoe.new('message_block', '0.1.0') do |p|
+  p.description    = "Handle multiple flash messages and ActiveRecord validation errors with ease."
+  p.url            = "http://github.com/railsgarden/message_block"
+  p.author         = "Ben Hughes"
+  p.email          = "ben@railsgarden.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/assets/stylesheets/message_block.css

@@ -0,0 +1,38 @@
+#message_block {
+  clear: both;
+  margin-top: 0.2em;
+  margin-bottom: 0.3em;
+}
+
+#message_block ul {
+  margin-bottom: 0;
+  list-style: none;
+  padding: 4px;
+}
+#message_block ul li {
+  margin-left: 3em;
+}
+
+#message_block ul.error {
+  border-top: 1px solid #ecd757;
+  border-bottom: 1px solid #ecd757;
+  background: #fcf6d0 url(../../images/message_block/error_m.gif) 1em 50% no-repeat;
+}
+
+#message_block ul.info {
+  border-top: 1px solid #ecd757;
+  border-bottom: 1px solid #ecd757;
+  background: #fcf6d0 url(../../images/message_block/info_m.gif) 1em 50% no-repeat;
+}
+
+#message_block ul.confirm {
+  border-top: 1px solid #ecd757;
+  border-bottom: 1px solid #ecd757;
+  background: #fcf6d0 url(../../images/message_block/confirmation_m.gif) 1em 50% no-repeat;
+}
+
+#message_block ul.warn {
+  border-top: 1px solid #ecd757;
+  border-bottom: 1px solid #ecd757;
+  background: #fcf6d0 url(../../images/message_block/warn_m.gif) 1em 50% no-repeat;
+}

data/init.rb

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

data/install.rb

@@ -0,0 +1,21 @@
+puts "Copying assets..."
+
+images_source = File.join(File.dirname(__FILE__), "assets", "images")
+stylesheets_source = File.join(File.dirname(__FILE__), "assets", "stylesheets", "message_block.css")
+
+images_target = File.join(RAILS_ROOT, "public", "images", "message_block")
+stylesheets_target = File.join(RAILS_ROOT, "public", "stylesheets", "message_block.css")
+
+unless File.exists?(images_target)
+  FileUtils.cp_r(images_source, images_target)
+  puts "  Copied Images"
+else
+  puts "  Images appear to already be installed, not copying."
+end
+
+unless File.exists?(stylesheets_target)
+  FileUtils.cp(stylesheets_source, stylesheets_target)
+  puts "  Copied Stylesheet"
+else
+  puts "  Stylesheet appears to already be installed, not copying"
+end

data/lib/message_block.rb

@@ -0,0 +1,3 @@
+require_dependency 'message_block/helpers'
+
+ActionView::Base.send(:include, Rubiety::MessageBlock::Helpers)

data/lib/message_block/helpers.rb

@@ -0,0 +1,51 @@
+module Rubiety
+  module MessageBlock
+    module Helpers
+      
+      def message_block(options = {})
+        options.assert_valid_keys(:on, :model_error_type, :flash_types, :html, :id, :class)
+        
+        options[:model_error_type] ||= :error
+        options[:flash_types] ||= [:back, :confirm, :error, :info, :warn]
+        options[:on] ||= controller.controller_name.split('/').last.gsub(/\_controller$/, '').singularize.to_sym
+        options[:html] ||= {:id => 'message_block'}
+        options[:html][:id] = options[:id] if options[:id]
+        options[:html][:class] = options[:class] if options[:class]
+        
+        flash_messages = {}
+        
+        options[:flash_types].each do |type|
+          entries = flash[type.to_sym]
+          next if entries.nil?
+          entries = [entries] unless entries.is_a?(Array)
+          
+          flash_messages[type.to_sym] ||= []
+          flash_messages[type.to_sym] += entries
+        end
+        
+        options[:on] = [options[:on]] unless options[:on].is_a?(Array)
+        
+        options[:on] = [options[:on]] unless options[:on].is_a?(Array)
+        model_objects = options[:on].map do |model_object|
+          if model_object.instance_of?(String) or model_object.instance_of?(Symbol)
+            instance_variable_get("@#{model_object}")
+          else
+            model_object
+          end
+        end.select {|m| !m.nil? }
+        
+        model_errors = model_objects.inject([]) {|b, m| b += m.errors.full_messages }
+        
+        flash_messages[options[:model_error_type].to_sym] ||= []
+        flash_messages[options[:model_error_type].to_sym] += model_errors
+        
+        contents = flash_messages.keys.select {|type| !flash_messages[type.to_sym].empty? }.map do |type|
+          content_tag(:ul, flash_messages[type.to_sym].map {|message| content_tag(:li, message) }.join, :class => type)
+        end.join
+        
+        content_tag(:div, contents, options[:html])
+      end
+      
+    end
+  end
+end

data/message_block.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{message_block}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Hughes"]
+  s.date = %q{2009-01-16}
+  s.description = %q{Handle multiple flash messages and ActiveRecord validation errors with ease.}
+  s.email = %q{ben@railsgarden.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/message_block/helpers.rb", "lib/message_block.rb", "README.rdoc"]
+  s.files = ["assets/images/back.gif", "assets/images/back_m.gif", "assets/images/confirmation.gif", "assets/images/confirmation_m.gif", "assets/images/error.gif", "assets/images/error_m.gif", "assets/images/info.gif", "assets/images/info_m.gif", "assets/images/warn.gif", "assets/images/warn_m.gif", "assets/stylesheets/message_block.css", "CHANGELOG", "init.rb", "install.rb", "lib/message_block/helpers.rb", "lib/message_block.rb", "MIT-LICENSE", "Rakefile", "README.rdoc", "test/message_block_helper_test.rb", "Manifest", "message_block.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/railsgarden/message_block}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Message_block", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{message_block}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Handle multiple flash messages and ActiveRecord validation errors with ease.}
+  s.test_files = ["test/message_block_helper_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/message_block_helper_test.rb

@@ -0,0 +1,193 @@
+require 'rubygems'
+require 'test/unit'
+require 'action_pack'
+require 'action_view'
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require File.dirname(__FILE__) + '/../init'
+
+class MessageBlockHelperTest < Test::Unit::TestCase
+  include ActionView::Helpers::TagHelper
+  include Rubiety::MessageBlock::Helpers
+  
+  # Borrowed model stubs from Rails active_record_helper_test.rb
+  # TODO: Re-implement using mocha
+  Post = Struct.new("Post", :title, :author_name)
+  User = Struct.new("User", :email)
+  
+  def setup_post
+    @post = Post.new
+    def @post.errors
+      Class.new do
+        def on(field)
+          case field.to_s
+          when "author_name"
+            "can't be empty"
+          when "body"
+            true
+          else
+            false
+          end
+        end
+        def empty?() false end
+        def count() 1 end
+        def full_messages() [ "Author name can't be empty" ] end
+      end.new
+    end
+    
+    @post.title       = "Hello World"
+    @post.author_name = ""
+  end
+  
+  def setup_user
+    @user = User.new
+    def @user.errors
+      Class.new {
+        def on(field) field == "email" end
+        def empty?() false end
+        def count() 1 end
+        def full_messages() [ "User email can't be empty" ] end
+      }.new
+    end
+    
+    @user.email = ""
+  end
+  
+  def controller
+    @controller ||= Class.new {
+      def controller_name
+        "widgets_controller"
+      end
+    }.new
+  end
+  
+  def posts_controller
+    Class.new {
+      def controller_name
+        "posts_controller"
+      end
+    }.new
+  end
+  
+  def flash
+    @flash ||= {}
+  end
+  
+  
+  def setup
+    setup_post
+    setup_user
+  end
+  
+  
+  ### Generic Invocation
+  def test_doesnt_accept_invalid_options
+    assert_raise(ArgumentError) { message_block :invalid => 'value' }
+  end
+  
+  def test_accepts_valid_options
+    assert_nothing_raised do 
+      message_block :on => :post, 
+        :model_error_type => "fail",
+        :flash_types => %w(error warn),
+        :html => {:style => 'height: 10em'},
+        :id => "block",
+        :class => "messages"
+    end
+  end
+  
+  
+  ### Grabbing model errors functionality
+  def test_without_errors_should_show_nothing
+    expected = %(<div id="message_block"></div>)
+    assert_equal expected, message_block
+  end
+  
+  def test_automatically_find_post_errors_with_posts_controller
+    @controller = posts_controller
+    expected = %(<div id="message_block"><ul class="error"><li>Author name can't be empty</li></ul></div>)
+    assert_equal expected, message_block
+  end
+  
+  def test_gives_error_for_post
+    expected = %(<div id="message_block"><ul class="error"><li>Author name can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => :post)
+  end
+  
+  def test_gives_error_for_user
+    expected = %(<div id="message_block"><ul class="error"><li>User email can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => :user)
+  end
+  
+  def test_gives_both_errors_for_post_and_user
+    expected = %(<div id="message_block"><ul class="error"><li>Author name can't be empty</li><li>User email can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => [:post, :user])
+  end
+  
+  def test_gives_both_errors_for_post_and_user_in_correct_order
+    expected = %(<div id="message_block"><ul class="error"><li>User email can't be empty</li><li>Author name can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => [:user, :post])
+  end
+  
+  def test_gives_error_for_user_given_direct_instance_variable
+    expected = %(<div id="message_block"><ul class="error"><li>User email can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => @user)
+  end
+  
+  def test_respects_model_error_type
+    expected = %(<div id="message_block"><ul class="fail"><li>User email can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => :user, :model_error_type => "fail")
+  end
+  
+  
+  ### Extending HTML options for containing div functionality
+  def test_can_specify_id_for_containing_div
+    expected = %(<div id="messages"></div>)
+    assert_equal expected, message_block(:id => "messages")
+  end
+  
+  def test_can_specify_class_for_containing_div
+    expected = %(<div class="messages" id="message_block"></div>)
+    assert_equal expected, message_block(:class => "messages")
+  end
+  
+  def test_can_specify_html_options_for_containing_div
+    expected = %(<div class="messages" id="block"></div>)
+    assert_equal expected, message_block(:html => {:id => "block", :class => "messages"})
+  end
+  
+  
+  ### Flash messages functionality
+  def test_sees_flash_error_string
+    flash[:error] = "Error A"
+    expected = %(<div id="message_block"><ul class="error"><li>Error A</li></ul></div>)
+    assert_equal expected, message_block
+  end
+  
+  def test_sees_flash_error_array
+    flash[:error] = ["Error A", "Error B"]
+    expected = %(<div id="message_block"><ul class="error"><li>Error A</li><li>Error B</li></ul></div>)
+    assert_equal expected, message_block
+  end
+  
+  def test_sees_default_flash_types
+    default_types = [:back, :confirm, :error, :info, :warn]
+    default_types.each do |type|
+      flash[type] = type.to_s
+    end
+    
+    expected_contents = default_types.map do |type|
+      content_tag(:ul, content_tag(:li, type.to_s), :class => type.to_s)
+    end.join
+    
+    expected = %(<div id="message_block">#{expected_contents}</div>)
+    assert_equal expected, message_block
+  end
+  
+  def test_sees_flash_error_alongside_model_error
+    flash[:error] = "Error A"
+    expected = %(<div id="message_block"><ul class="error"><li>Error A</li><li>Author name can't be empty</li></ul></div>)
+    assert_equal expected, message_block(:on => :post)
+  end
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: railsgarden-message_block
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Handle multiple flash messages and ActiveRecord validation errors with ease.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/message_block/helpers.rb
+- lib/message_block.rb
+- README.rdoc
+files: 
+- assets/images/back.gif
+- assets/images/back_m.gif
+- assets/images/confirmation.gif
+- assets/images/confirmation_m.gif
+- assets/images/error.gif
+- assets/images/error_m.gif
+- assets/images/info.gif
+- assets/images/info_m.gif
+- assets/images/warn.gif
+- assets/images/warn_m.gif
+- assets/stylesheets/message_block.css
+- CHANGELOG
+- init.rb
+- install.rb
+- lib/message_block/helpers.rb
+- lib/message_block.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/message_block_helper_test.rb
+- Manifest
+- message_block.gemspec
+has_rdoc: true
+homepage: http://github.com/railsgarden/message_block
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Message_block
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: message_block
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Handle multiple flash messages and ActiveRecord validation errors with ease.
+test_files: 
+- test/message_block_helper_test.rb