simply_messages 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in simply_messages.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2011 Paweł Gościcki
+
+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,87 @@
+= simply_messages
+
+simply_messages is a Rails plugin providing a unified notice/alert messages handling (like those: flash.now[:notice] = 'Yeah').
+Based on the message_block plugin by Ben Hughes (http://github.com/railsgarden/message_block).
+
+
+== Requirements
+
+Rails version 3.0+
+
+
+== Installation
+
+Put this line in your Gemfile:
+
+  gem 'simply_messages'
+
+Then bundle:
+
+  bundle
+
+
+In `app/views/layouts/application.html.erb`:
+
+  <%= messages_block %>
+
+
+By default the messages_block function will display all flash[:notice] and flash[:alert] messages and all errors for model object associated by name with the current controller (so it will display all model errors for @user model when 'users' is the current controller).
+
+Will also display appropriate messages for :success and :error flash keys.
+
+
+We can also specify the model we would like to display errors for, like this:
+
+  <%= messages_block :for => :comment %>
+
+We can also display errors for more than one model:
+
+  <%= messages_block :for => [:post, :comment] %>
+
+
+=== EXAMPLE 1
+
+controller:
+
+  flash.now[:notice] = 'Post saved'
+
+view:
+
+  <%= messages_block %>
+
+will result in:
+
+  <div class="notice">
+  <p>Post saved.</p>
+  </div>
+
+
+=== EXAMPLE 2
+
+users_controller:
+
+  @user.errors.add('name', 'name should not be empty')
+  flash.now[:alert] = 'Unable to add user'
+
+view:
+
+  <%= messages_block %>
+
+will result in:
+
+  <div class="alert">
+  <p>Unable to add user:</p>
+  <ul>
+  <li>name should not be empty</li>
+  </ul>
+  </div>
+
+
+== Contributing to simply_messages
+
+* Fork, fix, then send me a pull request.
+
+
+== Copyright
+
+Copyright (c) 2009-2011 Paweł Gościcki, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  require 'simply_messages/version'
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simply_messages #{SimplyMessages::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/simply_messages.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'simply_messages/railtie')

data/lib/simply_messages/action_view_extension.rb

@@ -0,0 +1,72 @@
+module SimplyMessages
+
+  module ActionViewExtension
+
+    extend ::ActiveSupport::Concern
+
+    module InstanceMethods
+      def messages_block(options = {})
+
+        # make options[:for] an array
+        options[:for] ||= []
+        options[:for] = [options[:for]] unless options[:for].is_a?(Array)
+
+        # add model object associated with current controller
+        options[:for] << controller.controller_name.split('/').last.gsub(/\_controller$/, '').singularize.to_sym
+
+        # fetch all model objects
+        model_objects = options[:for].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? }.uniq
+
+        # all models errors
+        models_errors = []
+        model_objects.each do |m|
+          errors = m.errors.entries.collect {|field, message| message}.select {|m| m.present?}
+          models_errors.concat(errors) if errors.any?
+        end
+
+        # messages_block
+        messages_block = ''
+
+        # flash[:success] or flash[:notice]
+        if flash[:success].present? or flash[:notice].present?
+
+          key = flash[:success].present? ? :success : :notice
+
+          msg = content_tag(:p, flash[key] + '.')
+          messages_block += content_tag(:div, msg, :class => key.to_s)
+        end
+
+        # flash[:error] or flash[:alert] or models errors
+        if flash[:error].present? or flash[:alert] or models_errors.any?
+          key = flash[:error].present? ? :error : :alert
+          msg = ''
+
+          if flash[key].present?
+            msg += content_tag(:p, flash[key] + (models_errors.any? ? ':' : '.'))
+          end
+
+          if models_errors.any?
+            errors = []
+            models_errors.each do |e|
+              errors << content_tag(:li, e)
+            end
+            msg += content_tag(:ul, errors.join)
+          end
+
+          messages_block += content_tag(:div, msg, :class => key.to_s)
+        end
+
+        messages_block
+      end
+
+    end
+
+  end
+
+end

data/lib/simply_messages/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+require File.join(File.dirname(__FILE__), 'action_view_extension')
+
+module SimplyMessages
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'simply_messages' do |app|
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, SimplyMessages::ActionViewExtension
+      end
+    end
+  end
+end
+

data/lib/simply_messages/version.rb

@@ -0,0 +1,3 @@
+module SimplyMessages
+  VERSION = '0.0.1'
+end

data/simply_messages.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "simply_messages/version"
+
+Gem::Specification.new do |s|
+  s.name = 'simply_messages'
+  s.version = SimplyMessages::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Paweł Gościcki']
+  s.email = ['pawel.goscicki@gmail.com']
+  s.homepage = 'https://github.com/pjg/simply_messages'
+  s.summary = 'Unified flash notices and model error messages display solution'
+  s.description = 'simply_messages is a unified flash and error messages display solution'
+
+  s.rubyforge_project = 'simply_messages'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ['README.rdoc']
+  s.require_paths = ['lib']
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 3.0.0']
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'sqlite3', ['>= 0']
+end

data/test/functional/helpers_test.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'action_controller'
+require 'action_controller/test_process'
+
+class Mock
+  attr_accessor :errors
+
+  def initialize(opts = {})
+    # create Errors object so I could add errors to this mock model
+    @errors = ActiveRecord::Errors.new(self)
+  end
+end
+
+class MocksController < ApplicationController
+  def success
+    flash.now[:success] = 'We have a success'
+    render :inline => '<%= messages_block %>'
+  end
+
+  def notice
+    flash.now[:notice] = 'We have a notice'
+    render :inline => '<%= messages_block %>'
+  end
+
+  def error
+    flash.now[:error] = 'Error: no luck this time'
+    render :inline => '<%= messages_block %>'
+  end
+
+  def alert
+    flash.now[:alert] = 'Alert: no luck this time'
+    render :inline => '<%= messages_block %>'
+  end
+
+  def model_error
+    flash.now[:error] = 'Model error'
+    @mock = Mock.new
+    @mock.errors.add('name', 'just having some troubles')
+    render :inline => '<%= messages_block %>'
+  end
+end
+
+class MocksControllerTest < ActionController::TestCase
+
+  def setup
+    @controller = MocksController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+
+    ActionController::Routing::Routes.draw do |map|
+      map.connect ':controller/:action/:id'
+    end
+  end
+
+  def test_success
+    get :success
+    assert_select 'div.success p', :text => /We have a success./
+  end
+
+  def test_notice
+    get :notice
+    assert_select 'div.notice p', :text => /We have a notice./
+  end
+
+  def test_error
+    get :error
+    assert_select 'div.error p', :text => /Error: no luck this time./
+  end
+
+  def test_alert
+    get :alert
+    assert_select 'div.alert p', :text => /Alert: no luck this time./
+  end
+
+  def test_model_error
+    get :model_error
+    assert_select 'div.error p', :text => /Model error:/
+    assert_select 'div.error ul li', :text => /just having some troubles/
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+# Optional gems
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+# Load Rails
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: simply_messages
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Pawe\xC5\x82 Go\xC5\x9Bcicki"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: simply_messages is a unified flash and error messages display solution
+email: 
+- pawel.goscicki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/simply_messages.rb
+- lib/simply_messages/action_view_extension.rb
+- lib/simply_messages/railtie.rb
+- lib/simply_messages/version.rb
+- simply_messages.gemspec
+- test/functional/helpers_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/pjg/simply_messages
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: simply_messages
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Unified flash notices and model error messages display solution
+test_files: []
+