localizer_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d15b76bf8d085001ec59ea8a1c406ce3313b6489
+  data.tar.gz: 7c07323d603aee4f3fb365438b563aa695b11c6f
+SHA512:
+  metadata.gz: bdd8269abba8b4bffe563a0d97ea26042a3ee13b46ef5cfb922622ea2065986c639861c122effbc85736eb3b1543d0ab9de9fa37c191f2ec84e140837534afd0
+  data.tar.gz: e447afabd5902ec2f3ee1bb8dccfd93c95aa2c7e1208d06b9186d51bfad3f35e443ff473ff49f6a66c51639c8d3f1dfb16808d170acead7d5d4d07676bcb5cf0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Gianni Bellono
+
+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/README.md

@@ -0,0 +1,191 @@
+LocalizerRails
+=========
+Just some handy utilities to manage site localization, generator provided
+
+1. set/retrieve language if none selected
+2. build language menu (bootstrap 3+ compatible)
+3. <i>[optional]</i> convenience partials and Kaminari pluralization patch (up to v0.16.3)
+
+Requirements
+------------
+Rails version: 4+
+
+**Gemfile**:
+
+    gem 'localizer_rails', '0.1.0'
+**Style**:
+<pre>    @import 'localizer_rails/localizer_rails';</pre>
+         &nbsp;&nbsp;&nbsp;&nbsp;OR
+<pre>    require localizer_rails</pre>
+
+
+Description
+-----------
+### **<i>set_loc</i>** method
+
+finds the best-match for `I18n.locale` through a cascading search:
+
+1. params[:locale]
+2. cookies['locale']
+3. current_user.locale (if defined)
+4. session[:locale]
+5. accepted_locales (scans browser's HTTP_ACCEPT_LANGUAGE)
+6. I18n.default_locale (if everything else fails)
+
+and sets values accordingly (cookies, link_to, ...)
+
+1. use in __<i>before_action</i>__:
+<pre>    before_action LocalizerRails::SetLoc</pre>
+
+2. use in __<i>routes</i>__, too:
+<pre>    scope ":locale", locale: /#{LocalizerRails.active_locales.join("|")}/ do ...<br/>
+      ...<br/>
+  match '*path', to: redirect { |p, req|
+                   Localizer.set_locale(req)
+                   if( ! (Localizer.active_locales.any? { |word| req.path.starts_with? ("/#{word}/") }) )
+                     "/#{I18n.locale}#{req.path}"
+                   else
+                     if( 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
+                   end
+                 },
+                 via: [ :get, :post, :patch, :delete ],
+                 status: '301'
+
+
+### **<i>active_locales_map</i>** method
+
+builds an hash of locale key/value pairs useful to build a `locale_menu`
+
+<i>[optional]</i> override and edit `config/LocalizerRails/lang_countries.yml`
+
+<pre>
+    :da:
+      :lang_default:    'Danish'
+      :lang_local:      'Dansk'
+      :country_default: 'Denmark'
+      :country_local:   'Danmark'
+      :country_code:    'DK'
+    :fo-FO:
+      :lang_default:    'Faroese'
+      :lang_local:      'Føroyskt'
+      :country_default: 'Faroe Islands'
+      :country_local:   'Føroyar'
+      :country_code:    'FO'
+</pre>
+
+<i>where</i>
+
+* __:lang_default__: language name in default language (ex.: english)
+* __:lang_local__: language name in local language/alphabet
+
+xtra country specs, use if `locale_menu` lists countries instead of languages:
+
+* __:country_default__: country name in default language (english)
+* __:country_local__: country name in local language/alphabet
+* __:country_code__: country ISO code
+
+__<i>NOTE</i>__: languages will be listed ONLY if included in `i18n.available_locales`
+
+<i>[optional]</i> edit __<i>LI structure</i>__ and attributes in
+    `app/views/LocalizerRails/_item[.bootstrap].html.erb`
+
+<i>[optional]</i> edit __<i>LI elements</i>__ and their display order in
+    `app/views/LocalizerRails/_elements.html.erb`
+
+__CONFIGURATION__
+
+<i>[optional]</i> override and edit `config/initializers/LocalizerRails/LocalizerRails_prefs.rb`
+
+<pre>
+LocalizerRails::Conf.configure do |conf|
+    conf.variable_name = value
+    ...</pre>
+
+__OPTIONS:__
+
+* __conf.merge_lang_countries_tables__ = (boolean)<br/>
+if a copy of the `lang_countries.yml` file is found in your application you can force the engine to use ONLY your file or the MERGED hash
+    - the engine's file will be used if no override `lang_countries` file is found in your application
+    - defaults to __<i>true</i>__ (= merge files if override file is found)
+
+* __conf.all_available_locales__ (boolean)<br/>
+    - set to <i>true</i> if
+        - you want to load all locales in `I18n.available_locales`
+        - you have already selected a limited bunch of locale files to be loaded in `your config.i18n.available_locales = [:en,'es-CO', :de]`
+    - set to <i>false</i> if you want to specify the locale files in the custom list below (`conf.active_locales`)
+    - defaults to __<i>true</i>__
+
+    __<i>Hint:</i>__ install [rails-i18n] (https://github.com/svenfuchs/rails-i18n) to add pluralization rules and a bunch of translated language files.
+
+
+* __conf.active_locales__ (:sym)<br/>
+define which locales your application will use
+    - locales not included in `I18n.available_locales` will be ignored
+    - defaults to __<i>[I18n.default_locale]</i>__
+
+* __conf.country_downcase__ = (boolean)<br/>
+load locale files depending on your setup:
+    - true   = use browser's HTTP_ACCEPT_LANGUAGE format (en-us)
+    - false  = use ISO rules in your `[localefile].yml` (en-US) as in `rails-i18n` locale files
+    - defaults to __<i>false</i>__
+
+* __conf.display_local_language__ = (boolean)<br/>
+display menu language names in their own idiom and alphabet or always in the default site language:
+    - true  = 'Italiano', 'Español', 'Deutsch', ...
+    - false = 'Italian', 'Spanish', 'German', ... (or whatever language your `config.i18n.default_locale` defaults to)
+    - defaults to __<i>false</i>__
+
+* __conf.use_bootstrap__ = (boolean)<br/>
+use bootstrap-style in `locale_menu` (you need to include bootstrap-sass (or similar) in your gemfile and import it in your stylesheet), as opposed to this engine's provided style
+    - defaults to __<i>false</i>__ (= use engine's style)
+
+* __conf.cookie_expires__ = (Date | nil)<br/>
+set a custom expiration date for the `:cookies[:locale]`
+    - Date can be in the format 20.year.from_now.utc (same as cookies.permanent)
+    - defaults to __<i>nil</i>__ (session length)
+
+* __conf.store_in_session__ = (boolean)<br/>
+store `I18n.locale` also in session?
+    - defaults to __<i>false</i>__
+
+## Extras (optional)
+
+### **Kaminari override**
+
+[Kaminari] (https://github.com/amatsuda/kaminari) (up to current v0.16.3) handles pluralization through <i>pluralize</i>.<br/>
+In case of localization with foreign languages (eventually with multiple plural forms, such as cyrillic) this method often outputs incorrect results.<br/>
+The generator installs an override for Kaminari's `ActionViewExtension#page_entries_info`, following a bright hint by <a href="https://github.com/Linuus" target="_blank">Linuus</a> found on <a href="https://github.com/amatsuda/kaminari/pull/309" target="_blank">GitHub</a> (see 'Credits' below).<br/>
+The patch uses model_name and AR's count.<br/>
+__<i>Note:</i>__ You need to install the [kaminari ~> 0.16] (https://github.com/amatsuda/kaminari) and [kaminari-i18n] (https://github.com/tigrish/kaminari-i18n) gems.
+
+### **Bootstrap 3+ NAVBAR raw partial**
+The generator installs a raw partial with the code for a Bootstrap 3+ NAVBAR featuring the language menu, modify it to suit your needs.<br/>
+__<i>Note:</i>__ You need to install [bootstrap-sass] (https://github.com/twbs/bootstrap-sass) or a similar gem.
+
+### **dummy app**
+Type the following lines in your Terminal application to see a working example:
+
+    $ cd path-to-your-dir
+    $ git clone https://github.com/gbellono/localizer_rails.git
+    $ cd path-to-your-dir/localizer_rails
+    $ bundle install
+    $ rails s
+Check out comments included in the code.<br/>
+__<i>Note:</i>__ to simulate the 'production' error handling remember to set `config.consider_all_requests_local` in `config/environments/development.rb` to `false`.
+
+
+## Credits
+
+Thanks to [Linuus](https://github.com/Linuus) for suggesting a viable way to patch Kaminari's handling of pluralization issues.
+
+## Copyright
+
+Copyright (c) 2015 by [Giovanni Bellono](mailto://giovanni.bellono@gmail.com)<br>
+See [LICENSE](https://github.com/gbellono/localizer_rails/blob/master/MIT-LICENSE) for details.
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LocalizerRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test