localizer_rails 0.1.0

data/lib/generators/localizer_rails/localizer_rails_generator.rb

@@ -0,0 +1,119 @@
+class LocalizerRails::LocalizerRailsGenerator < Rails::Generators::Base
+
+  def init
+    ## INSTALL ALL IF NO OPTION SELECTED
+    @has_options = options.any? { |k, v|
+      !!v
+    }
+  end
+
+  source_root File.expand_path(LocalizerRails::Engine.root, __FILE__)
+
+  class_option :views,  :type => :boolean, :default => false, :aliases => "-v", :desc => "[views] Install partials to override the default language dropdown-menu output."
+  class_option :routes, :type => :boolean, :default => false, :aliases => "-r", :desc => "[routes] Append (commented hint) code in your route.rb to match *paths without prepended locale."
+  class_option :config, :type => :boolean, :default => false, :aliases => "-c", :desc => "[config] Install preference file to change settings for LocalizerRails."
+  class_option :map,    :type => :boolean, :default => false, :aliases => "-m", :desc => "[maps] Install the language-country map .yml to edit the translations."
+  class_option :nav,    :type => :boolean, :default => false, :aliases => "-n", :desc => "[navigation] Install the bootstrap navbar partial (requires bootstrap gem)."
+  class_option :kam,    :type => :boolean, :default => false, :aliases => "-k", :desc => "[pagination] Install Kaminari (v0.16.3) pluralization patch."
+
+  def self.banner
+    "rails generate localizer_rails"
+  end
+
+  def manifest
+
+    ## == VIEWS
+    if options[:views] || !@has_options
+      copy_file File.join( *%w( app views localizer_rails _item.html.erb ) ),           ( Rails.root.join( *%w( app views localizer_rails _item.html.erb ) ) )
+      copy_file File.join( *%w( app views localizer_rails _item.bootstrap.html.erb ) ), ( Rails.root.join( *%w( app views localizer_rails _item.bootstrap.html.erb ) ) )
+      copy_file File.join( *%w( app views localizer_rails _elements.html.erb ) ),       ( Rails.root.join( *%w( app views localizer_rails _elements.html.erb ) ) )
+   end
+
+    ## == PREFERENCES
+    if options[:config] || !@has_options
+      copy_file File.join(*%w( lib generators localizer_rails templates localizer_rails_prefs.rb )), (Rails.root.join(*%w( config initializers localizer_rails localizer_rails_prefs.rb )))
+    end
+
+    ## == Language-Country map
+    if options[:map] || @all
+      copy_file File.join(*%w( config localizer_rails lang_countries.yml )), (Rails.root.join(*%w( config localizer_rails lang_countries.yml )))
+    end
+
+    ## == [HANDY] Kaminari pluralization patch (as of v0.16.3)
+    if options[:kam] || !@has_options
+      copy_file File.join(*%w( lib generators localizer_rails templates kaminari_action_view_extension.rb )), (Rails.root.join(*%w( config initializers kaminari_action_view_extension.rb )))
+    end
+
+    ## == [HANDY] Bootstrap 3+ NAVBAR partial
+    if options[:nav] || !@has_options
+      copy_file File.join(*%w( lib generators localizer_rails templates _header.html.erb )), (Rails.root.join(*%w( app views layouts _header.html.erb )))
+    end
+
+    ## == ROUTES
+    if options[:routes] || !@has_options
+      append_to_file Rails.root.join(*%w( config routes.rb )) do |a|
+        %q{
+__END__
+## --- LocalizerRails routes and match-alls
+
+## (1) move inside your 'locale' scope to create the routes to your custom error pages:
+## NOTES:
+#   forget about the system error 500, your app might be too broken to handle it
+
+# Rails.application.routes.draw do
+    scope ":locale", :locale => /#{LocalizerRails.active_locales.join("|")}/ do
+#     ...
+      %w( 404 ).each do |code|
+        get code, :to => "errors#show", :code => code, :as => "error_#{code}"
+      end
+
+## (2) move after your 'locale' scope if you need match-all routes prepending missing locale
+## NOTES:
+#   - for TESTING POURPOSES in development, REMEMBER to CHANGE this value in config/environments/development
+#         config.consider_all_requests_local       = true
+#     to:
+#         config.consider_all_requests_local       = false
+#     => full error reports are disabled, and Rails treats all requests as in production
+
+  match '*path', :to     => redirect { |p, req|
+                                       LocalizerRails.set_locale(req)
+
+                                       case
+                                       when LocalizerRails.active_locales.none? { |word| req.path.starts_with?("/#{word}/") }
+                                         ## TRY prepending the locale
+                                         "/#{I18n.locale}#{req.path}"
+                                       when Rails.env.production? || !Rails.application.config.consider_all_requests_local
+                                         ## SHOW custom 404
+                                         Rails.application.routes.url_helpers.error_404_path(:locale => I18n.locale)
+                                       else
+                                         ## let Rails handle this with default 404
+                                         raise ActionController::RoutingError.new('Not Found')
+                                       end
+                                     },
+                 :via    => [ :get, :post, :patch, :delete ],
+                 :status => '301'
+
+  match '', :to     => redirect { |p, req| LocalizerRails.set_locale(req) },
+            :via    => [:get, :post, :patch, :delete],
+            :status => '301'
+}
+      end
+    end
+  end
+
+  def show_setup_message
+    puts %q{
+    Setup done!
+
+    REMEMBER: if you want to test the redirection to your custom pages CHANGE the value in config/environments/development to FALSE:
+        config.consider_all_requests_local = false
+    and then change it back when you're done testing.
+
+    REMEMBER to IMPORT/REQUIRE the engine's stylesheet
+        @import 'localizer_rails/localizer_rails';
+      OR
+        require localizer_rails
+    }
+  end
+end
+

data/lib/generators/localizer_rails/templates/_header.html.erb

@@ -0,0 +1,33 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container-fluid">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar_collapse">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="#">My Site</a>
+    </div>
+
+    <div class="collapse navbar-collapse" id="navbar_collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= current_page?(root_path) ? 'active' : nil %>"><%= link_to "Home", root_path %></li>
+        <li class="<%= current_page?(page_path) ? 'active' : nil %>"><%= link_to "Page", page_path %></li>
+      </ul>
+      <ul class="nav navbar-nav navbar-right">
+
+
+        <li class="dropdown">
+          <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
+            Language <b class="caret"></b>
+          </a>
+          <ul class="dropdown-menu locale_menu scroll-menu" role="menu">
+            <%= render 'localizer_rails/language_menu' %>
+          </ul>
+        </li>
+
+      </ul>
+    </div>
+  </div>
+</nav>

data/lib/generators/localizer_rails/templates/kaminari_action_view_extension.rb

@@ -0,0 +1,30 @@
+## ADD to the Gemfile:
+## add the kaminari pagination (https://github.com/amatsuda/kaminari)
+# gem 'kaminari', '~> 0.16'
+## add the kaminari translations (https://github.com/tigrish/kaminari-i18n)
+# gem 'kaminari-i18n'
+
+
+## OVERRIDE KAMINARI METHOD to use Rails CLDR (Common Locale Data Repository) pluralization translations
+require 'kaminari/helpers/action_view_extension.rb'
+module Kaminari
+  module ActionViewExtension
+
+    def page_entries_info(collection, options = {})
+      ## from a post by https://github.com/Linuus in https://github.com/amatsuda/kaminari/pull/309
+      #- entry_name = options[:entry_name] || collection.entry_name
+      #- entry_name = entry_name.pluralize unless collection.total_count == 1
+      #+ entry_name = collection.model_name.human(:count => collection.total_count, :default => collection.model_name.human.pluralize).downcase
+      entry_name = collection.model_name.human(:count => collection.total_count, :default => collection.model_name.human.pluralize).downcase
+
+      if collection.total_pages < 2
+        t('helpers.page_entries_info.one_page.display_entries', :entry_name => entry_name, :count => collection.total_count)
+      else
+        first = collection.offset_value + 1
+        last  = collection.last_page? ? collection.total_count : collection.offset_value + collection.limit_value
+        t('helpers.page_entries_info.more_pages.display_entries', :entry_name => entry_name, :first => first, :last => last, :total => collection.total_count)
+      end.html_safe
+    end
+
+  end
+end

data/lib/generators/localizer_rails/templates/localizer_rails_prefs.rb

@@ -0,0 +1,22 @@
+## CUSTOM CONFIGURATION:
+## install/copy this file to
+#       config/initializers/localizer_rails/
+# and uncomment/edit the values you want to customize.
+
+LocalizerRails::Conf.configure do |conf|
+  # conf.merge_lang_countries_tables = true
+  # conf.all_available_locales = true
+  # conf.active_locales = [ :en,
+  #                         :'en-GB'
+  #                       ]
+  # conf.country_downcase = false
+  ## DISPLAY LANGUAGE IN ITS OWN IDIOM?
+  # conf.display_local_language = false
+  ## LOCALE_MENU STYLE
+  # conf.use_bootstrap = false
+  ## COOKIES
+  # conf.cookie_expires = nil                   # ( = session )(default)
+  # conf.cookie_expires = 20.year.from_now.utc  # ( = cookies.permanent )
+  ## SESSION
+  # conf.store_in_session = false
+end

data/lib/localizer_rails/engine.rb

@@ -0,0 +1,15 @@
+require "localizer_rails/version"
+
+module LocalizerRails
+  class Engine < ::Rails::Engine
+    isolate_namespace LocalizerRails
+
+    ## LOAD HELPER
+    initializer 'localizer_rails.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        # helper LocalizerRails::LocalizerRailsHelper
+        helper LocalizerRails::Engine.helpers
+      end
+    end
+  end
+end

data/lib/localizer_rails/set_locale.rb

@@ -0,0 +1,9 @@
+module LocalizerRails
+  module SetLocale
+    extend self
+
+    def before(arg)
+      LocalizerRails.set_locale(arg)
+    end
+  end
+end

data/lib/localizer_rails/version.rb

@@ -0,0 +1,3 @@
+module LocalizerRails
+  VERSION = "0.1.0"
+end

data/lib/localizer_rails.rb

@@ -0,0 +1,126 @@
+require "localizer_rails/engine"
+require "localizer_rails/set_locale"
+
+module LocalizerRails
+  extend self
+
+  ##================== CONFIGURATION DEFAULT SETTINGS & USER PREFS
+
+  Conf = OpenStruct.new :merge_lang_countries_tables => true,
+                        :all_available_locales       => true,
+                        :active_locales              => [ I18n.default_locale ],
+                        :country_downcase            => false,
+                        :display_local_language      => false,
+                        :use_bootstrap               => false,
+                        :cookie_expires              => nil,
+                        :store_in_session            => false
+
+  def Conf.configure(*, &block)
+    block.call self
+  end
+
+  # Allows LocalizerRails.method instead of LocalizerRails::Conf.method
+  def method_missing(meth, *args, &block)
+    Conf.respond_to?(meth) ? Conf.send(meth, *args, &block) : super
+  end
+
+  ##==============================================================
+
+  ## DEFINE WHICH LOCALES SHOULD BE AVAILABLE TO THE APPLICATION:
+  def active_locales
+    @active_locales_temp ||= begin
+      if Conf.all_available_locales.blank?
+        I18n.available_locales & Conf.active_locales
+      else
+        I18n.available_locales
+      end
+    end
+  end
+
+  ## FIND BEST-MATCH LOCALE:
+  def set_locale(req)
+    I18n.locale = req.params[:locale] ||
+                  req.send(:cookies)['locale'] ||
+                  (req.current_user.locale if (!!(defined? req.current_user.locale))) ||
+                  req.session[:locale] ||
+                  accepted_locales(req.env['HTTP_ACCEPT_LANGUAGE']) ||
+                  I18n.default_locale
+    ## FALLBACK IF INVALID DATA IN COOKIES, ...
+    I18n.locale = I18n.default_locale unless active_locales.include?(I18n.locale)
+    ## SET COOKIE:
+    req.send(:cookies)[:locale]                           = { :value   => I18n.locale,
+                                                              :expires => Conf.cookie_expires
+                                                            }
+    ## SET SESSION:
+    req.send(:session)[:locale]                           = I18n.locale unless Conf.store_in_session.blank?
+    ## LOCALIZE LINKS
+    Rails.application.routes.default_url_options[:locale] = I18n.locale
+
+    ## RETURN LOCALE:
+    I18n.locale
+  end
+
+  PATH_TO_LANG = %w[ config localizer_rails lang_countries.yml ]
+
+  ## BUILD LOCALE MAP:
+  def active_locales_map
+    @my_locales_ok ||= begin
+                          custom_file_path = Rails.root.join(*PATH_TO_LANG)
+                          loc_map          = if File.exist?(custom_file_path)
+                                               if Conf.merge_lang_countries_tables
+                                                 lang_file(Engine).merge(lang_file(Rails))
+                                               else
+                                                 lang_file(Rails)
+                                               end
+                                             else
+                                               lang_file(Engine)
+                                             end
+
+                          my_locales_temp  = {}
+
+                          if Conf.all_available_locales.blank?
+                            active_locales.each do |k|
+                              next unless I18n.available_locales.include?(k) && loc_map.key?(k)
+                              my_locales_temp[k] = loc_map[k]
+                            end
+
+                          else
+                            I18n.available_locales.each do |k|
+                              next unless loc_map.key?(k)
+                              my_locales_temp[k] = loc_map[k]
+                            end
+                          end
+                          my_locales_temp
+                        end
+  end
+
+  private
+
+  def lang_file(what)
+    YAML.load( File.read(what.root.join(*PATH_TO_LANG)) )
+  end
+
+  ## FIND HTTP_ACCEPT_LANGUAGE best-match locale
+  def accepted_locales(http_accept_language)
+    return false if http_accept_language.blank?
+
+    langs = http_accept_language.scan(/([a-zA-Z]{2,4})(?:(-[a-zA-Z]{2}))?(?:;q=(1|0?\.[0-9]{1,3}))?/).map do |pair|
+
+      lang, country, q = pair
+
+      ccase     = Conf.country_downcase.blank? ? :upcase : :downcase
+      # try to create lang-country pair
+      lang_test = lang + country.try(ccase).to_s
+
+      # match against active locales and use pair if exist
+      lang = lang_test if active_locales_map.include?(lang_test.to_sym)
+      # add preference q=1.0 if missing
+      [lang.to_sym, (q || '1').to_f]
+    end
+
+    # sort by preference
+    langs.sort_by { |lang, q| q }.map { |lang, q| lang }.reverse
+    # return first choice
+    langs.first[0]
+  end
+end

data/lib/tasks/localizer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :localizer_rails do
+#   # Task goes here
+# end