bootstrap_flash_messages 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+bootstrap_flash_messages*.gem
+.bundle
+pkg

data/Gemfile

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

data/README.md

@@ -0,0 +1,133 @@
+# bootstrap_flash_messages
+
+    version 0.0.1
+    Robin Brouwer
+    45north
+
+Bootstrap alerts and Rails flash messages combined in one easy-to-use gem.
+
+
+## Installation
+
+You can use this gem by putting the following inside your Gemfile:
+
+    gem "bootstrap_flash_messages"
+
+Now you need flash.en.yml for the flash messages.
+
+    rails g bootstrap_flash_messages:locale
+
+And that's it!
+
+
+## Changes
+
+Version 0.0.1 changes (08/08/2012):
+    
+    - Changed redirect_to method
+    - Added flash! and flash_now! methods
+    - Added flash_messages helper
+    - Made a gem out of it
+
+
+## Usage
+
+You need [Twitter Bootstrap](http://twitter.github.com/bootstrap) for the styling and close button. You can still use it without Bootstrap, but you need to style it yourself. This gem uses the [Bootstrap alerts](http://twitter.github.com/bootstrap/components.html#alerts).
+
+All flash messages are defined inside config/locales/flash.en.yml. They are nested like this:
+
+    en:
+      flash_messages:
+        controller_name:
+          action_name:
+            success: "It worked!"
+            info: "There's something you need to know..."
+            warning: "You should watch out now."
+            error: "Oh no! Something went wrong."
+
+You have four keys:
+    
+    :success
+    :info
+    :warning
+    :error
+
+When you've defined the messages it's really easy to call them inside your Controller.
+
+    class PostsController
+      def create
+        @post = Post.new(params[:post])
+        if @post.save
+          redirect_to(@post, :flash => :success)
+        else
+          flash_now!(:error)
+          render("new")
+        end
+      end
+    end
+
+You can use the `:flash` parameter inside the `redirect_to` method (note: this gem changes the redirect_to method!) to set the flash messages. You only need to pass the corresponding key and the gem will automatically set `gflash[:success]` to `t("flash_messages.posts.create.success")`. The `:flash` parameter also accepts an Array.
+
+    redirect_to(@post, :flash => [:success, :info])
+
+You can still use a Hash to use the default `redirect_to` behavior. When you don't want to use the `redirect_to` method to set the flash messages, you can use the `flash!` method.
+
+    flash!(:success, :info)
+    redirect_to(@post)
+
+When you need to use `flash.now` you can use the new `flash_now!` method.
+
+    flash_now!(:error, :warning)
+
+You use `flash_now!` in combination with rendering a view instead of redirecting.
+
+Now's the time to show these messages to the user. Inside the layout (or any other view), add the following:
+
+    <div id="flash_messages"><%= flash_messages %></div>
+
+And that's it! To change the flash messages inside a `.js.erb` file, you can do the following:
+
+    $("#flash_messages").html("#{j(flash_messages)}");
+
+The `flash_messages` helper shows a simple Bootstrap alert box. If you want to add a close button you can add the :close option.
+
+    <%= flash_messages(:close) %>
+
+Want to use the `.alert-block` class? Just add :block.
+
+    <%= flash_messages(:close, :block) %>
+
+Want a heading? Add :heading. The headings inside flash.en.yml are used.
+
+    <%= flash_messages(:close, :block, :heading) %>
+
+And that's it! Have fun. :)
+
+
+## Why I created this gem
+
+I created the [gritter gem](https://github.com/RobinBrouwer/gritter) and used it in a lot of projects.
+I started using Twitter Bootstrap and really liked the alerts. I loved the way gritter allowed you to set messages
+and decided to do the same for the Bootstrap alerts. And this is the result!
+
+## Copyright
+
+Copyright (C) 2012 Robin Brouwer
+
+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,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bootstrap_flash_messages.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bootstrap_flash_messages/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bootstrap_flash_messages"
+  s.version     = BootstrapFlashMessages::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Robin Brouwer"]
+  s.email       = ["robin@45north.nl"]
+  s.homepage    = "http://www.45north.nl"
+  s.summary     = %q{Bootstrap alerts and Rails flash messages combined in one easy-to-use gem.}
+  s.description = %q{Bootstrap alerts and Rails flash messages combined in one easy-to-use gem.}
+  
+  s.rubyforge_project = "nowarning"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'bootstrap_flash_messages'
+BootstrapFlashMessages.initialize

data/lib/bootstrap_flash_messages/flash_messages.rb

@@ -0,0 +1,37 @@
+module BootstrapFlashMessages
+  module FlashMessages
+    def redirect_to(options = {}, response_status_and_flash = {})
+      messages = response_status_and_flash[:flash]
+      if messages && (messages.is_a?(Symbol) || messages.is_a?(Array))
+        flashes = {}
+        if messages.is_a?(Array)
+          messages.each do |key|
+            flashes[key] = flash_messages(params[:controller], params[:action], key)
+          end
+        else
+          flashes[messages] = flash_messages(params[:controller], params[:action], messages)
+        end
+        response_status_and_flash[:flash] = flashes
+      end
+      super(options, response_status_and_flash)
+    end
+
+  private
+
+    def flash!(*args)
+      args.each do |key|
+        flash[key] = flash_messages(params[:controller], params[:action], key)
+      end
+    end
+
+    def flash_now!(*args)
+      args.each do |key|
+        flash.now[key] = flash_messages(params[:controller], params[:action], key)
+      end
+    end
+
+    def flash_messages(*args)
+      I18n.t("flash_messages.#{args.join(".")}")
+    end
+  end
+end

data/lib/bootstrap_flash_messages/helpers.rb

@@ -0,0 +1,29 @@
+module BootstrapFlashMessages
+  module Helpers
+    def flash_messages(*args)
+      if flash.present?
+        block = args.include?(:block)
+        show_heading = args.include?(:heading)
+        show_close = args.include?(:close)
+        
+        messages = []
+        flash.each do |key, value|
+          heading = ""
+          if show_heading
+            heading_text = I18n.t("flash_messages.headings.#{key}")
+            heading = (block ? content_tag(:h4, heading_text, :class => "alert-heading") : content_tag(:strong, heading_text))
+          end
+          close = ""
+          if show_close
+            close = link_to("x", "#", :class => "close", :data => { :dismiss => "alert" })
+          end
+          
+          messages << content_tag(:div, :class => "alert alert-#{key} #{"alert-block" if block}") do
+            close + heading + " " + value
+          end
+        end
+        raw(messages.join)
+      end
+    end
+  end
+end

data/lib/bootstrap_flash_messages/railtie.rb

@@ -0,0 +1,9 @@
+if defined?(Rails::Railtie)
+  module BootstrapFlashMessages
+    class Railtie < Rails::Railtie
+      initializer :bootstrap_flash_messages do
+        BootstrapFlashMessages.initialize
+      end
+    end
+  end
+end

data/lib/bootstrap_flash_messages/version.rb

@@ -0,0 +1,3 @@
+module BootstrapFlashMessages
+  VERSION = "0.0.1"
+end

data/lib/bootstrap_flash_messages.rb

@@ -0,0 +1,16 @@
+require 'bootstrap_flash_messages/helpers'
+require 'bootstrap_flash_messages/flash_messages'
+
+module BootstrapFlashMessages
+  def self.initialize
+    return if @initialized
+    raise "ActionController is not available yet." unless defined?(ActionController)
+    ActionController::Base.send(:helper, BootstrapFlashMessages::Helpers)
+    ActionController::Base.send(:include, BootstrapFlashMessages::FlashMessages)
+    @initialized = true
+  end
+end
+
+if defined?(Rails::Railtie)
+  require 'bootstrap_flash_messages/railtie'
+end

data/lib/generators/bootstrap_flash_messages/USAGE

@@ -0,0 +1,7 @@
+Available generators:
+  bootstrap_flash_messages:locale
+
+Examples:
+  rails g bootstrap_flash_messages:locale
+  This will create:
+    config/locales/flash.en.yml

data/lib/generators/bootstrap_flash_messages/locale_generator.rb

@@ -0,0 +1,9 @@
+module BootstrapFlashMessages
+  class LocaleGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def copy_gflash_locale
+      copy_file "flash.en.yml", "config/locales/flash.en.yml"
+    end
+  end
+end

data/lib/generators/bootstrap_flash_messages/templates/flash.en.yml

@@ -0,0 +1,35 @@
+en:
+  flash_messages:
+    #
+    # These are the translations for the different headings.
+    #
+    headings:
+      success: "Success!"
+      info: "Info!"
+      warning: "Warning!"
+      error: "Error!"
+    #
+    # Add flash messages for controller actions:
+    # products:
+    #   create:
+    #     success: "This is a notification"
+    #     error: "Something went wrong"
+    #
+    # Inside controller:
+    # def create
+    #   flash!(:success, :error)
+    #   redirect_to(:root)
+    # end
+    #
+    # OR
+    # 
+    # def create
+    #   redirect_to(:root, :flash => [:success, :error])
+    # end
+    #
+    # OR
+    #
+    # def create
+    #   flash_now!(:success, :error)
+    #   render("new")
+    # end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: bootstrap_flash_messages
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robin Brouwer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Bootstrap alerts and Rails flash messages combined in one easy-to-use gem.
+email: 
+- robin@45north.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bootstrap_flash_messages.gemspec
+- init.rb
+- lib/bootstrap_flash_messages.rb
+- lib/bootstrap_flash_messages/flash_messages.rb
+- lib/bootstrap_flash_messages/helpers.rb
+- lib/bootstrap_flash_messages/railtie.rb
+- lib/bootstrap_flash_messages/version.rb
+- lib/generators/bootstrap_flash_messages/USAGE
+- lib/generators/bootstrap_flash_messages/locale_generator.rb
+- lib/generators/bootstrap_flash_messages/templates/flash.en.yml
+has_rdoc: true
+homepage: http://www.45north.nl
+licenses: []
+
+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: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bootstrap alerts and Rails flash messages combined in one easy-to-use gem.
+test_files: []
+