locale_flash 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf654d1da5fa9ee31db5f9d6a249f3df0dc2390f
+  data.tar.gz: 89342725271cac17d241eeb68e8f85ac438ef4a2
+SHA512:
+  metadata.gz: 9b35b93724d89ea025924c65645d4050648727c0d1aa94268445b9ea43074ae1b668e3ba3befeca4212b6e455d59a1aa89081de8371fa7d025715e5883ce90b2
+  data.tar.gz: ada829e19c8581ee03bd83a9d3a3df1b3cc0edf9e162cd10960c09403dcecaf9175e10b5d0b81bc04a42c4e5b9d80202b3eb091f514f1d67ca834040481cc89f

data/lib/locale_flash/config.rb

@@ -0,0 +1,14 @@
+module LocaleFlash
+  class Config
+    DEFAULT_TEMPLATE = -> (type, str) { %Q{<div class="#{type}">#{str}</div>} }
+
+    def self.template=(value)
+      value = value.to_proc
+      @@template = value
+    end
+
+    def self.template
+      defined?(@@template) ? @@template : DEFAULT_TEMPLATE
+    end
+  end
+end

data/lib/locale_flash/flash.rb

@@ -11,13 +11,29 @@ module LocaleFlash
     end
 
     def self.from_params(type, params={})
-      if params.is_a?(Hash) && params[:controller] && params[:action]
+      if params_hash_stringkeys? params
+        build_from_hash_stringkeys type, params
+      elsif params.is_a?(Hash) && params[:controller] && params[:action]
         new(params.merge(:type => type))
       else
         new(:type => type, :message => params.to_s)
       end
     end
 
+    private_class_method def self.build_from_hash_stringkeys(type, params)
+      new(
+        :type       => type,
+        :controller => params["controller"],
+        :action     => params["action"],
+        :options    => params["options"]
+      )
+    end
+
+    private_class_method def self.params_hash_stringkeys?(params)
+      return false unless params.kind_of? Hash
+      %w[controller action].all? { |key| params.key? key }
+    end
+
     def to_params
       { :controller => controller,
         :action     => action,
@@ -60,7 +76,7 @@ module LocaleFlash
       else
         I18n.t(key, options.merge(:default => fallbacks))
       end
-      %Q{<div class="#{type}">#{str}</div>}
+      LocaleFlash::Config.template.call(type, str)
     end
   end
-end
+end

data/lib/locale_flash/version.rb

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

data/lib/locale_flash.rb

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

metadata

@@ -1,114 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: locale_flash
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Christopher Dell
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-29 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: i18n
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: locale_flash lets you create flash messages easily with I18n fallbacks
-email: 
+email:
 - chris@tigrish.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .rvmrc
-- Gemfile
-- Guardfile
-- README.markdown
-- Rakefile
+files:
 - lib/locale_flash.rb
+- lib/locale_flash/config.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/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
-has_rdoc: true
-homepage: ""
-licenses: []
-
+homepage: https://rubygems.org/gems/locale_flash
+licenses:
+- Nonstandard
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: locale_flash
-rubygems_version: 1.6.2
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Super charge your flash messages with I18n
-test_files: 
-- spec/fixtures/en.yml
-- 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
+test_files: []

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
--I ./lib
--I ./spec

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.2@locale_flash

data/Gemfile

@@ -1,2 +0,0 @@
-source "http://rubygems.org"
-gemspec

data/Guardfile

@@ -1,3 +0,0 @@
-guard 'rspec', :cli => "--color --format nested" do
-  watch(%r{^spec/.+_spec\.rb})
-end

data/README.markdown

@@ -1,90 +0,0 @@
-# locale_flash
-
-## Installation
-
-Add locale_flash to your Gemfile :
-
-    gem 'locale_flash'
-
-Install the gem :
-
-    bundle install
-
-And off you go!
-
-## Use
-
-### In your controllers
-
-Instead of manually assigning a value to flash[:notice] or flash[:alert], just call the *locale_flash* method like so :
-
-    class UsersController < ActionController::Base
-      def create
-        @user = User.new(params[:user])
-        if @user.save
-          locale_flash(:notice)
-          # redirect or render...
-        else
-          locale_flash(:alert)
-          # redirect or render...
-        end
-      end
-    end
-
-Notice and Alert are such common keys to assign to a flash message that 2 convenience methods are also included : *locale_notice* and *locale_alert*. This means that the previous example can be written like so :
-
-    class UsersController < ActionController::Base
-      def create
-        @user = User.new(params[:user])
-        if @user.save
-          locale_notice
-          # redirect or render...
-        else
-          locale_alert
-          # redirect or render...
-        end
-      end
-    end
-
-### In your views
-
-Simply call locale_flash from your views like so :
-
-    <div id="flash">
-      <%= locale_flash %>
-    </div>
-
-This will produce HTML output like this :
-
-    <div id="flash">
-      <div class="notice">My message here</div>
-    </div>
-
-
-Note : if you are adding locale_flash to an existing application with manual assignments to flash[:notice], this will be rendered without I18n lookups.
-
-### I18n fallback order
-
-Your actual message text should be stored in your locale files (ie: in config/locales/*.yml).
-
-locale_file will first look for the most specific message that matches the controller and action from which the flash was created from, and if that's missing, will fallback to more generic messages.
-
-Given that I call *locale_notice* from the create action in a UsersController, the order of fallbacks will be as follows :
-
-    controllers.users.create.flash.notice # this is the most specific message
-    controllers.users.flash.notice        # fallback to the notice message for this controller
-    controllers.flash.create.notice       # fallback to the notice message for all create actions
-    controllers.flash.notice              # fallback to the generic notice message
-
-Given a nested Admin::UsersController, the order of fallbacks will be as follows :
-
-    controllers.admin.users.create.flash.notice
-    controllers.admin.create.flash.show.notice
-    controllers.admin.create.flash.notice
-    controllers.admin.flash.notice
-    controllers.flash.create.notice
-    controllers.flash.notice
-
-## TODO
-+ Add an option to configure the wrapping html tags/classes
-+ Add the option of predefining common messages (like resource_created for example)

data/Rakefile

@@ -1,7 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
-
-task :default => :spec

data/locale_flash.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "locale_flash/version"
-
-Gem::Specification.new do |s|
-  s.name        = "locale_flash"
-  s.version     = LocaleFlash::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Christopher Dell"]
-  s.email       = ["chris@tigrish.com"]
-  s.homepage    = ""
-  s.summary     = %q{Super charge your flash messages with I18n}
-  s.description = %q{locale_flash lets you create flash messages easily with I18n fallbacks}
-
-  s.rubyforge_project = "locale_flash"
-
-  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"]
-
-  s.add_development_dependency('i18n')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('guard-rspec')
-end

data/spec/fixtures/en.yml

@@ -1,15 +0,0 @@
-en:
-  controllers:
-    flash:
-      notice: Found in controllers.flash.notice
-      show:
-        notice: Found in controllers.flash.show.notice
-    users:
-      flash:
-        notice: Found in controllers.users.flash.notice
-      create:
-        flash:
-          notice: Found in controllers.users.create.flash.notice
-      show:
-        flash:
-          notice: Showing profile for %{name}

data/spec/locale_flash/flash_spec.rb

@@ -1,203 +0,0 @@
-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/rails/action_controller_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-require 'support/controllers'
-
-describe ActionController::Base do
-  before(:each) do
-    @controller = UsersController.new
-  end
-
-  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', :options => {:name => 'Chris'}}}
-    end
-
-    context "when the controller is nested" do
-      before(:each) do
-        @controller = Admin::UsersController.new
-      end
-
-      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', :options => {}}}
-      end
-    end
-  end
-
-  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', :options => {:name => 'John'}}}
-    end
-  end
-
-  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', :options => {:name => 'Martin'}}}
-    end
-  end
-end

data/spec/locale_flash/rails/action_view_spec.rb

@@ -1,54 +0,0 @@
-require 'spec_helper'
-require 'support/templates'
-
-describe ActionView::Base do
-  before(:each) do
-    @template = UsersTemplate.new
-  end
-
-  describe '#locale_flash' do
-    context "when flash is empty" do
-      it "returns an empty string" do
-        @template.flash = {}
-        @template.locale_flash.should == ''
-      end
-    end
-
-    context "when flash is a string" do
-      it "returns an html flash" do
-        @template.flash = {:notice => 'This is a string'}
-        @template.locale_flash.should == %Q{<div class="notice">This is a string</div>}
-      end  
-
-      it "returns multiple html flashes" do
-        @template.flash = {:notice => 'This is a string', :alert => 'This is another string'}
-        html = @template.locale_flash
-        html.should include(%Q{<div class="notice">This is a string</div>})
-        html.should include(%Q{<div class="alert">This is another string</div>})
-      end
-    end
-
-    context "when flash is a hash containg controller and action keys" do
-      it "returns the flash for the controller and action" do
-        @template.flash = {:notice => {:controller => 'users', :action => 'create'}}
-        @template.locale_flash.should == %Q{<div class="notice">Found in controllers.users.create.flash.notice</div>}
-      end
-
-      it "returns the flash falling back to the controller flash" do
-        @template.flash = {:notice => {:controller => 'users', :action => 'update'}}
-        @template.locale_flash.should == %Q{<div class="notice">Found in controllers.users.flash.notice</div>}
-      end
-
-      it "returns the flash falling back to the action flash" do
-        @template.flash = {:notice => {:controller => 'pages', :action => 'show'}}
-        @template.locale_flash.should == %Q{<div class="notice">Found in controllers.flash.show.notice</div>}
-      end
-
-      it "returns the flash falling back to the key flash" do
-        @template.flash = {:notice => {:controller => 'other', :action => 'index'}}
-        @template.locale_flash.should == %Q{<div class="notice">Found in controllers.flash.notice</div>}
-      end
-    end
-  end
-
-end

data/spec/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'locale_flash'
-require 'i18n'
-
-I18n.load_path << 'spec/fixtures/en.yml'

data/spec/support/controllers.rb

@@ -1,50 +0,0 @@
-module ActionController
-  class Base
-    attr_accessor :flash
-
-    def initialize
-      @flash = {}
-    end
-  end
-end
-
-class UsersController < ActionController::Base
-  def edit
-    locale_flash(:warning, :name => 'Chris')
-  end
-
-  def create
-    locale_notice(:name => 'John')
-  end
-
-  def destroy
-    locale_alert(:name => 'Martin')
-  end
-
-private
-
-  def controller_path
-    'users'
-  end
-
-  def action_name
-    'create'
-  end
-end
-
-module Admin
-end
-
-class Admin::UsersController < ActionController::Base
-  def show
-    locale_alert
-  end
-
-  def controller_path
-    'admin/users'
-  end
-
-  def action_name
-    'show'
-  end
-end

data/spec/support/templates.rb

@@ -1,12 +0,0 @@
-module ActionView
-  class Base
-    attr_accessor :flash
-
-    def t(key, args={})
-      I18n.t(key, args)
-    end
-  end
-end
-  
-class UsersTemplate < ActionView::Base
-end