locale_flash 0.0.4 → 1.0.0

data/README.markdown

@@ -87,5 +87,4 @@ Given a nested Admin::UsersController, the order of fallbacks will be as follows
 
 ## TODO
 + Add an option to configure the wrapping html tags/classes
-+ Allow options to be passed to the I18n.t call (like :locale => :fr for example)
 + Add the option of predefining common messages (like resource_created for example)

data/lib/locale_flash/flash.rb

@@ -0,0 +1,66 @@
+module LocaleFlash
+  class Flash
+    attr_reader :type, :controller, :action, :options, :message
+
+    def initialize(args={})
+      @type       = args[:type]
+      @controller = args[:controller]
+      @action     = args[:action]
+      @options    = args[:options] || {}
+      @message    = args[:message]
+    end
+
+    def self.from_params(type, params={})
+      if params.is_a?(Hash) && params[:controller] && params[:action]
+        new(params.merge(:type => type))
+      else
+        new(:type => type, :message => params.to_s)
+      end
+    end
+
+    def to_params
+      { :controller => controller,
+        :action     => action,
+        :options    => options }
+    end
+
+    def legacy?
+      !message.nil?
+    end
+
+    def controllers
+      controller.split('/')
+    end
+
+    def key
+      ['controllers', controllers.join('.'), action, 'flash', type].join('.').to_sym
+    end
+
+    def fallbacks
+      if controllers.size > 1
+        defaults = []
+        controllers.each_with_index do |current, i|
+          current    = controllers[0, (controllers.size - i)].join('.')
+          parent     = controllers[0, (controllers.size - i - 1)].join('.')
+          defaults << ['controllers', current, 'flash', type]
+          defaults << ['controllers', parent, 'flash', action, type] unless parent.empty?
+        end
+      else
+        defaults = [['controllers', controller, 'flash', type]]
+      end
+
+      defaults << ['controllers', 'flash', action, type]
+      defaults << ['controllers', 'flash', type]
+      defaults.map { |i| i.join('.').to_sym }
+    end
+
+    def to_html
+      str = if legacy?
+        message
+      else
+        I18n.t(key, options.merge(:default => fallbacks))
+      end
+      %Q{<div class="#{type}">#{str}</div>}
+    end
+  end
+end

data/lib/locale_flash/rails/action_controller.rb

@@ -0,0 +1,31 @@
+module LocaleFlash
+  module Rails
+    module ActionController
+      
+    private
+    
+      def locale_flash(type, options={})
+        flash[type] = LocaleFlash::Flash.new(
+          :controller => controller_path,
+          :action     => action_name,
+          :type       => type,
+          :options    => options
+        ).to_params
+      end
+
+      def locale_notice(options={})
+        locale_flash :notice, options
+      end
+
+      def locale_alert(options={})
+        locale_flash :alert, options
+      end
+    end
+  end
+end
+  
+module ActionController
+  class Base
+    include LocaleFlash::Rails::ActionController
+  end
+end

data/lib/locale_flash/rails/action_view.rb

@@ -0,0 +1,22 @@
+module LocaleFlash
+  module Rails
+    module ActionView
+
+      def locale_flash
+        output = ''
+        flash.each do |type, args|
+          output << LocaleFlash::Flash.from_params(type, args).to_html
+        end
+        output.respond_to?(:html_safe) ? output.html_safe : output
+      end
+
+    end
+  end
+end
+
+
+module ActionView
+  class Base
+    include LocaleFlash::Rails::ActionView
+  end
+end

data/lib/locale_flash/version.rb

@@ -1,3 +1,3 @@
 module LocaleFlash
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/lib/locale_flash.rb

@@ -1,2 +1,3 @@
-require 'locale_flash/action_controller'
-require 'locale_flash/action_view'
+require 'locale_flash/flash'
+require 'locale_flash/rails/action_controller'
+require 'locale_flash/rails/action_view'

data/spec/fixtures/en.yml

@@ -9,4 +9,7 @@ en:
         notice: Found in controllers.users.flash.notice
       create:
         flash:
-          notice: Found in controllers.users.create.flash.notice
+          notice: Found in controllers.users.create.flash.notice
+      show:
+        flash:
+          notice: Showing profile for %{name}

data/spec/locale_flash/flash_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+describe LocaleFlash::Flash do
+  describe '.from_params(type, params)' do
+    context "when a complete Hash is passed" do
+      before do
+        @flash = LocaleFlash::Flash.from_params(:notice, {
+          :controller => 'admin/users',
+          :action     => 'update',
+          :options    => {:name => 'Chris'}
+        })
+      end
+
+      it "returns a non legacy Flash" do
+        @flash.should_not be_legacy
+      end
+
+      it "sets the type" do
+        @flash.type.should == :notice
+      end
+
+      it "sets the action" do
+        @flash.action.should == 'update'
+      end
+
+      it "sets the controller" do
+        @flash.controller.should == 'admin/users'
+      end
+
+      it "sets the options" do
+        @flash.options.should == {:name => 'Chris'}
+      end
+    end
+
+    context "when an invalid Hash is passed" do
+      before do
+        @flash = LocaleFlash::Flash.from_params(:notice, {
+          :controller => 'admin/users',
+          :options    => {:name => 'Chris'}
+          # NOTE no :action
+        })
+      end
+
+      it "returns a legacy Flash" do
+        @flash.should be_legacy
+      end
+
+      it "sets the type" do
+        @flash.type.should == :notice
+      end
+
+      it "sets the message to the string version of the hash" do
+        @flash.message.should_not be_nil
+        @flash.message.should be_kind_of(String)
+      end
+    end
+
+    context "when a String is passed" do
+      before do
+        @flash = LocaleFlash::Flash.from_params(:notice, "I'm a flash")
+      end
+
+      it "returns a legacy Flash" do
+        @flash.should be_legacy
+      end
+
+      it "sets the type" do
+        @flash.type.should == :notice
+      end
+
+      it "sets message to the String" do
+        @flash.message.should == "I'm a flash"
+      end
+    end
+  end
+
+  describe '#to_params' do
+    it "returns a hash of attributes" do
+      LocaleFlash::Flash.new(
+        :type       => :notice,
+        :controller => 'admin/users',
+        :action     => 'show',
+        :options    => {:foo => :bar}
+      ).to_params.should == {
+        :controller => 'admin/users',
+        :action     => 'show',
+        :options    => {:foo => :bar}
+      }
+    end
+  end
+
+  describe '#legacy?' do
+    it "returns true when message is set" do
+      LocaleFlash::Flash.new(:message => 'foo').should be_legacy
+    end
+
+    it "returns false when message is NOT set" do
+      LocaleFlash::Flash.new.should_not be_legacy
+    end
+  end
+
+  describe '#controllers' do
+    it "returns an array with 1 element when controller is simple" do
+      LocaleFlash::Flash.new(:controller => 'users').controllers.should == ['users']
+    end
+
+    it "returns an array of controllers when controller is nested" do
+      LocaleFlash::Flash.new(:controller => 'admin/users').controllers.should == ['admin', 'users']
+    end
+  end
+
+  describe '#key' do
+    it "returns the correct key for a simple controller" do
+      LocaleFlash::Flash.new(
+        :controller => 'users',
+        :action     => 'update',
+        :type       => :notice
+      ).key.should == :'controllers.users.update.flash.notice'
+    end
+
+    it "returns the correct key for a newsted controller" do
+      LocaleFlash::Flash.new(
+        :controller => 'admin/users',
+        :action     => 'update',
+        :type       => :notice
+      ).key.should == :'controllers.admin.users.update.flash.notice'
+    end
+  end
+
+  describe '#fallbacks' do
+    it "should be correct for simple controllers" do
+      LocaleFlash::Flash.new(
+        :controller => 'users',
+        :action => 'show',
+        :type => :notice
+      ).fallbacks.should == [
+        :"controllers.users.flash.notice",
+        :"controllers.flash.show.notice",
+        :"controllers.flash.notice"
+      ]
+    end
+
+    it "should be correct for nested controllers" do
+      LocaleFlash::Flash.new(
+        :controller => 'admin/users',
+        :action => 'show',
+        :type => :notice
+      ).fallbacks.should == [
+        :"controllers.admin.users.flash.notice",
+        :"controllers.admin.flash.show.notice",
+        :"controllers.admin.flash.notice",
+        :"controllers.flash.show.notice",
+        :"controllers.flash.notice"
+      ]
+    end
+
+    it "should be correct for multiply nested controllers" do
+      LocaleFlash::Flash.new(
+        :controller => 'admin/users/projects',
+        :action => 'show',
+        :type => :notice
+      ).fallbacks.should == [
+        :"controllers.admin.users.projects.flash.notice",
+        :"controllers.admin.users.flash.show.notice",
+        :"controllers.admin.users.flash.notice",
+        :"controllers.admin.flash.show.notice",
+        :"controllers.admin.flash.notice",
+        :"controllers.flash.show.notice",
+        :"controllers.flash.notice"
+      ]
+    end
+  end
+
+  describe '#to_html' do
+    def wrap(str)
+      %Q{<div class="notice">#{str}</div>}
+    end
+
+    context "when flash is legacy" do
+      it "returns the message" do
+        flash = LocaleFlash::Flash.new(:message => 'Hello there!', :type => :notice)
+        flash.to_html.should == wrap('Hello there!')
+      end
+    end
+
+    context "when flash is a locale_flash" do
+      it "returns the translated string" do
+        flash = LocaleFlash::Flash.new(:controller => 'users', :action => 'create', :type => :notice)
+        flash.to_html.should == wrap('Found in controllers.users.create.flash.notice')
+      end
+
+      it "passes options to I18n" do
+        flash = LocaleFlash::Flash.new(:controller => 'users', :action => 'show', :type => :notice, :options => {:name => 'Chris'})
+        flash.to_html.should == wrap('Showing profile for Chris')
+      end
+      
+      it "passes fallbacks to I18n" do
+        flash = LocaleFlash::Flash.new(:controller => 'users', :action => 'destroy', :type => :notice)
+        flash.to_html.should == wrap('Found in controllers.users.flash.notice')
+      end
+    end
+  end
+end

data/spec/locale_flash/{action_controller_spec.rb → rails/action_controller_spec.rb}

@@ -6,10 +6,10 @@ describe ActionController::Base do
     @controller = UsersController.new
   end
 
-  describe '#locale_flash(key)' do
-    it "sets flash[key] to a hash containing the controller name and the action name" do
+  describe '#locale_flash(key, options)' do
+    it "sets flash[key] to a hash containing the controller name, the action name and passed options" do
       @controller.edit
-      @controller.flash.should == {:warning => {:controller => 'users', :action => 'create'}}
+      @controller.flash.should == {:warning => {:controller => 'users', :action => 'create', :options => {:name => 'Chris'}}}
     end
 
     context "when the controller is nested" do
@@ -19,22 +19,22 @@ describe ActionController::Base do
 
       it "sets the flash[key] to a hash containing the full path to the controller and the action name" do
         @controller.show
-        @controller.flash.should == {:alert => {:controller => 'admin/users', :action => 'show'}}
+        @controller.flash.should == {:alert => {:controller => 'admin/users', :action => 'show', :options => {}}}
       end
     end
   end
 
-  describe '#locale_notice' do
-    it "sets flash[:notice] to a hash contianing the controller name and the action name" do
+  describe '#locale_notice(options)' do
+    it "sets flash[:notice] to a hash contianing the controller name, the action name and passed options" do
       @controller.create
-      @controller.flash.should == {:notice => {:controller => 'users', :action => 'create'}}
+      @controller.flash.should == {:notice => {:controller => 'users', :action => 'create', :options => {:name => 'John'}}}
     end
   end
 
-  describe '#locale_alert' do
-    it "sets flash[:alert] to a hash contianing the controller name and the action name" do
+  describe '#locale_alert(options)' do
+    it "sets flash[:alert] to a hash contianing the controller name, the action name and passed options" do
       @controller.destroy
-      @controller.flash.should == {:alert => {:controller => 'users', :action => 'create'}}
+      @controller.flash.should == {:alert => {:controller => 'users', :action => 'create', :options => {:name => 'Martin'}}}
     end
   end
 end

data/spec/locale_flash/{action_view_spec.rb → rails/action_view_spec.rb}

@@ -51,44 +51,4 @@ describe ActionView::Base do
     end
   end
 
-  describe "#locale_flash_default(type, msg)" do
-    it "should be correct for simple controllers" do
-      @template.send(
-        :locale_flash_default,
-        :notice, {:controller => 'users',  :action => 'show'}
-      ).should == [
-        :"controllers.users.flash.notice",
-        :"controllers.flash.show.notice",
-        :"controllers.flash.notice"
-      ]
-    end
-
-    it "should be correct for nested controllers" do
-      @template.send(
-        :locale_flash_default,
-        :notice, {:controller => 'admin/users', :action => 'show'}
-      ).should == [
-        :"controllers.admin.users.flash.notice",
-        :"controllers.admin.flash.show.notice",
-        :"controllers.admin.flash.notice",
-        :"controllers.flash.show.notice",
-        :"controllers.flash.notice"
-      ]
-    end
-
-    it "should be correct for multiply nested controllers" do
-      @template.send(
-        :locale_flash_default,
-        :notice, {:controller => 'admin/users/projects', :action => 'show'}
-      ).should == [
-        :"controllers.admin.users.projects.flash.notice",
-        :"controllers.admin.users.flash.show.notice",
-        :"controllers.admin.users.flash.notice",
-        :"controllers.admin.flash.show.notice",
-        :"controllers.admin.flash.notice",
-        :"controllers.flash.show.notice",
-        :"controllers.flash.notice"
-      ]
-    end
-  end
 end

data/spec/support/controllers.rb

@@ -10,15 +10,15 @@ end
 
 class UsersController < ActionController::Base
   def edit
-    locale_flash(:warning)
+    locale_flash(:warning, :name => 'Chris')
   end
 
   def create
-    locale_notice
+    locale_notice(:name => 'John')
   end
 
   def destroy
-    locale_alert
+    locale_alert(:name => 'Martin')
   end
 
 private

metadata

@@ -2,7 +2,7 @@
 name: locale_flash
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - Christopher Dell
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 +02:00
+date: 2011-05-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,13 +64,15 @@ files:
 - README.markdown
 - Rakefile
 - lib/locale_flash.rb
-- lib/locale_flash/action_controller.rb
-- lib/locale_flash/action_view.rb
+- lib/locale_flash/flash.rb
+- lib/locale_flash/rails/action_controller.rb
+- lib/locale_flash/rails/action_view.rb
 - lib/locale_flash/version.rb
 - locale_flash.gemspec
 - spec/fixtures/en.yml
-- spec/locale_flash/action_controller_spec.rb
-- spec/locale_flash/action_view_spec.rb
+- spec/locale_flash/flash_spec.rb
+- spec/locale_flash/rails/action_controller_spec.rb
+- spec/locale_flash/rails/action_view_spec.rb
 - spec/spec_helper.rb
 - spec/support/controllers.rb
 - spec/support/templates.rb
@@ -98,14 +100,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: locale_flash
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Super charge your flash messages with I18n
 test_files: 
 - spec/fixtures/en.yml
-- spec/locale_flash/action_controller_spec.rb
-- spec/locale_flash/action_view_spec.rb
+- spec/locale_flash/flash_spec.rb
+- spec/locale_flash/rails/action_controller_spec.rb
+- spec/locale_flash/rails/action_view_spec.rb
 - spec/spec_helper.rb
 - spec/support/controllers.rb
 - spec/support/templates.rb

data/lib/locale_flash/action_controller.rb

@@ -1,24 +0,0 @@
-module LocaleFlash
-  module ActionController
-    
-  private
-  
-    def locale_flash(key)
-      flash[key] = {:controller => controller_path, :action => action_name}
-    end
-
-    def locale_notice
-      locale_flash :notice
-    end
-
-    def locale_alert
-      locale_flash :alert
-    end
-  end
-end
-  
-module ActionController
-  class Base
-    include LocaleFlash::ActionController
-  end
-end

data/lib/locale_flash/action_view.rb

@@ -1,55 +0,0 @@
-module LocaleFlash
-  module ActionView
-
-    def locale_flash
-      output = ''
-      flash.each do |key, value|
-        if value.is_a?(Hash) && value[:controller] && value[:action]
-          output << locale_flash_wrap(key, t(locale_flash_key(key, value), :default => locale_flash_default(key, value)))
-        else
-          output << locale_flash_wrap(key, value)
-        end
-      end
-
-      output.respond_to?(:html_safe) ? output.html_safe : output
-    end
-
-  private
-
-    def locale_flash_wrap(key, value)
-      %Q{<div class="#{key}">#{value}</div>}
-    end
-
-    def locale_flash_key(key, value)
-      ['controllers', value[:controller].split('/').join('.'), value[:action], 'flash', key].join('.').to_sym
-    end
-
-    def locale_flash_default(type, msg)
-      controllers = msg[:controller].split('/')
-
-      if controllers.size > 1
-        defaults = []
-        controllers.each_with_index do |controller, i|
-          controller = controllers[0, (controllers.size - i)].join('.')
-          parent     = controllers[0, (controllers.size - i - 1)].join('.')
-          defaults << ['controllers', controller, 'flash', type]
-          defaults << ['controllers', parent, 'flash', msg[:action], type] unless parent.empty?
-        end
-      else
-        defaults = [['controllers', controllers.first, 'flash', type]]
-      end
-
-      defaults << ['controllers', 'flash', msg[:action], type]
-      defaults << ['controllers', 'flash', type]
-      defaults.map { |i| i.join('.').to_sym }
-    end
-
-  end
-end
-
-
-module ActionView
-  class Base
-    include LocaleFlash::ActionView
-  end
-end