Module: Padrino::Contrib::AutoLocale

Defined in:
lib/padrino-contrib/auto_locale.rb

Overview

This extension give to padrino the ability to change their locale inspecting.

Usage

class MyApp < Padrino::Application
  register AutoLocale
  set :locales, [:en, :ru, :de] # First locale is the default locale
  set :locale_exclusive_paths, ['/js', '/css', '/img'] # asset uri paths which shouldn't be localized
end

# view.haml
=link_to "View this page in RU Version", switch_to_lang(:ru)

So when we call an url like: /ru/blog/posts this extension set for you :ru as I18n.locale

Defined Under Namespace

Modules: ClassMethods, Helpers

Class Method Summary collapse

Class Method Details

.excluded_path?(path, excluded_paths) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
94
95
96
97
98
99
 
# File 'lib/padrino-contrib/auto_locale.rb', line 91

def self.excluded_path?(path, excluded_paths)
  excluded_paths.detect do |excluded_path|
    if excluded_path.is_a?(Regexp)
      !!excluded_path.match(path)
    elsif excluded_path.is_a?(String)
      path.start_with?(excluded_path.end_with?("/") ? excluded_path : "#{excluded_path}/")
    end
  end
end

.padrino_route_added(route, verb, path, args, options, block) ⇒ Object 



81
82
83
84
85
86
87
88
89
 
# File 'lib/padrino-contrib/auto_locale.rb', line 81

def self.padrino_route_added(route, verb, path, args, options, block)
  ##
  # TODO: Regex original_path needs to be served as well.
  #
  return unless route.original_path.is_a?(String)
  excluded_paths = block.binding.eval('settings').locale_exclusive_paths
  return if AutoLocale.excluded_path?(route.original_path, excluded_paths)
  route.path = "/:lang#{route.original_path}" unless route.original_path =~ /:lang/
end

.registered(app) ⇒ Object

Helpers



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/padrino-contrib/auto_locale.rb', line 32

def self.registered(app)
  app.helpers Padrino::Contrib::AutoLocale::Helpers
  app.extend ClassMethods
  app.set :locales, [:en]
  app.set :locale_exclusive_paths, []
  @@exclusive_paths = false
  app.before do
    # Gather excluded paths
    unless @@exclusive_paths.is_a?(Array)
      # auto include sinatra-assetpack configuration
      if settings.respond_to?(:assets) and
        settings.assets.respond_to?(:served) and
        settings.assets.served.is_a?(Hash)
        @@exclusive_paths = settings.locale_exclusive_paths + settings.assets.served.keys
      else
        @@exclusive_paths = settings.locale_exclusive_paths
      end
    end

    # Default to the first locale
    I18n.locale = settings.locales.first

    # First check if the path starts with a known locale
    if request.path_info =~ /^\/(#{settings.locales.join('|')})\b/
      I18n.locale = $1.to_sym

    # Then check if the path is excluded
    elsif AutoLocale.excluded_path?(request.path_info, @@exclusive_paths)
      next

    # Root path "/" needs special treatment, as it doesn't contain any language parameter.
    elsif request.path_info =~ /^\/?$/
      # Try to guess the preferred language from the http header
      for browser_locale in (request.env['HTTP_ACCEPT_LANGUAGE'] || '').split(",")
        locale = browser_locale.split(";").first.downcase.sub('-', '_')
        if settings.locales.include?(locale.to_sym)
          I18n.locale = locale.to_sym
          break
        end
      end
      # Then redirect from "/" to "/:lang" to match the new routing urls
      redirect url("/#{I18n.locale.to_s}/", false)

    # Return 404 not found for everything else
    else
      not_found
    end
  end

  def self.padrino_route_added(route, verb, path, args, options, block)
    ##
    # TODO: Regex original_path needs to be served as well.
    #
    return unless route.original_path.is_a?(String)
    excluded_paths = block.binding.eval('settings').locale_exclusive_paths
    return if AutoLocale.excluded_path?(route.original_path, excluded_paths)
    route.path = "/:lang#{route.original_path}" unless route.original_path =~ /:lang/
  end

  def self.excluded_path?(path, excluded_paths)
    excluded_paths.detect do |excluded_path|
      if excluded_path.is_a?(Regexp)
        !!excluded_path.match(path)
      elsif excluded_path.is_a?(String)
        path.start_with?(excluded_path.end_with?("/") ? excluded_path : "#{excluded_path}/")
      end
    end
  end
end