localizer_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d15b76bf8d085001ec59ea8a1c406ce3313b6489
-  data.tar.gz: 7c07323d603aee4f3fb365438b563aa695b11c6f
+  metadata.gz: c3644371397c6f5017271befc6444cfc36d0dc8a
+  data.tar.gz: ac255a81643018c3f717358f684a8b7d60edd426
 SHA512:
-  metadata.gz: bdd8269abba8b4bffe563a0d97ea26042a3ee13b46ef5cfb922622ea2065986c639861c122effbc85736eb3b1543d0ab9de9fa37c191f2ec84e140837534afd0
-  data.tar.gz: e447afabd5902ec2f3ee1bb8dccfd93c95aa2c7e1208d06b9186d51bfad3f35e443ff473ff49f6a66c51639c8d3f1dfb16808d170acead7d5d4d07676bcb5cf0
+  metadata.gz: c3e2fc1803eda158cd2fcc0fe81bce79fc490dfc0acc88e93a4221d9d9fed0eb5406632386e8dd32d81313b1daec3ea6faa92691863d2335deb1f16ddee67b37
+  data.tar.gz: 3663a468b152fcc22304d04676a13e0e25402c38542d4345f703b7a67bf13b4a88f37a772180650699bcc16e8c8f0969a5981c0c071b3334936ccee099eb45c2

data/README.md

@@ -4,7 +4,7 @@ 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)
+3. _[optional]_ convenience partials and Kaminari pluralization patch (up to v0.16.3)
 
 Requirements
 ------------
@@ -12,16 +12,18 @@ Rails version: 4+
 
 **Gemfile**:
 
-    gem 'localizer_rails', '0.1.0'
+    gem 'localizer_rails', '0.1.1'
 **Style**:
-<pre>    @import 'localizer_rails/localizer_rails';</pre>
-         &nbsp;&nbsp;&nbsp;&nbsp;OR
-<pre>    require localizer_rails</pre>
+
+    @import 'localizer_rails/localizer_rails';
+OR
+
+    require localizer_rails
 
 
 Description
 -----------
-### **<i>set_loc</i>** method
+### **_set_loc_** method
 
 finds the best-match for `I18n.locale` through a cascading search:
 
@@ -34,12 +36,15 @@ finds the best-match for `I18n.locale` through a cascading search:
 
 and sets values accordingly (cookies, link_to, ...)
 
-1. use in __<i>before_action</i>__:
-<pre>    before_action LocalizerRails::SetLoc</pre>
+1. use in **_before_action_**:
+
+<pre>before_action LocalizerRails::SetLoc</pre>
 
-2. use in __<i>routes</i>__, too:
-<pre>    scope ":locale", locale: /#{LocalizerRails.active_locales.join("|")}/ do ...<br/>
-      ...<br/>
+2. use in **_routes_**, too:
+
+<pre>
+scope ":locale", locale: /#{LocalizerRails.active_locales.join("|")}/ do ...
+  ...
   match '*path', to: redirect { |p, req|
                    Localizer.set_locale(req)
                    if( ! (Localizer.active_locales.any? { |word| req.path.starts_with? ("/#{word}/") }) )
@@ -56,30 +61,30 @@ and sets values accordingly (cookies, link_to, ...)
                  },
                  via: [ :get, :post, :patch, :delete ],
                  status: '301'
+</pre>
 
-
-### **<i>active_locales_map</i>** method
+### **_active_locales_map_** 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`
+_[optional]_ 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'
+: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>
+_where_
 
 * __:lang_default__: language name in default language (ex.: english)
 * __:lang_local__: language name in local language/alphabet
@@ -90,69 +95,70 @@ xtra country specs, use if `locale_menu` lists countries instead of languages:
 * __: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`
+**_NOTE_**: 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`
+_[optional]_ edit **_LI structure_** and attributes in
+<pre>app/views/LocalizerRails/_item[.bootstrap].html.erb</pre>
 
-<i>[optional]</i> edit __<i>LI elements</i>__ and their display order in
-    `app/views/LocalizerRails/_elements.html.erb`
+_[optional]_ edit **_LI elements_** and their display order in
+<pre>app/views/LocalizerRails/_elements.html.erb</pre>
 
 __CONFIGURATION__
 
-<i>[optional]</i> override and edit `config/initializers/LocalizerRails/LocalizerRails_prefs.rb`
+_[optional]_ override and edit `config/initializers/LocalizerRails/LocalizerRails_prefs.rb`
 
 <pre>
 LocalizerRails::Conf.configure do |conf|
     conf.variable_name = value
-    ...</pre>
+    ...
+</pre>
 
 __OPTIONS:__
 
-* __conf.merge_lang_countries_tables__ = (boolean)<br/>
+* __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)
+    - defaults to **_true_** (= merge files if override file is found)
 
 * __conf.all_available_locales__ (boolean)<br/>
-    - set to <i>true</i> if
+    - set to `true` 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>__
+    - set to `false` if you want to specify the locale files in the custom list below (`conf.active_locales`)
+    - defaults to **_true_**
 
-    __<i>Hint:</i>__ install [rails-i18n] (https://github.com/svenfuchs/rails-i18n) to add pluralization rules and a bunch of translated language files.
+    **_Hint:_** 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>__
+    - defaults to **_[I18n.default_locale]_**
 
-* __conf.country_downcase__ = (boolean)<br/>
+* __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>__
+    - `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 **_false_**
 
-* __conf.display_local_language__ = (boolean)<br/>
+* __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>__
+    - `true`  = 'Italiano', 'Español', 'Deutsch', ...
+    - `false` = 'Italian', 'Spanish', 'German', ... (or whatever language your `config.i18n.default_locale` defaults to)
+    - defaults to **_false_**
 
-* __conf.use_bootstrap__ = (boolean)<br/>
+* __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)
+    - defaults to **_false_** (= use engine's style)
 
-* __conf.cookie_expires__ = (Date | nil)<br/>
+* __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)
+    - defaults to **_nil_** (session length)
 
-* __conf.store_in_session__ = (boolean)<br/>
+* __conf.store_in_session__ (boolean)<br/>
 store `I18n.locale` also in session?
-    - defaults to __<i>false</i>__
+    - defaults to **_false_**
 
 ## Extras (optional)
 
@@ -161,12 +167,14 @@ store `I18n.locale` also in session?
 [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.
+The patch uses model_name and AR's count.
+
+**_Note:_** 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.
+The generator installs a raw partial with the code for a Bootstrap 3+ NAVBAR featuring the language menu, modify it to suit your needs.
+
+**_Note:_** 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:
@@ -176,8 +184,9 @@ Type the following lines in your Terminal application to see a working example:
     $ 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`.
+Check out comments included in the code.
+
+**_Note:_** to simulate the 'production' error handling remember to set `config.consider_all_requests_local` in `config/environments/development.rb` to `false`.
 
 
 ## Credits
@@ -186,6 +195,7 @@ Thanks to [Linuus](https://github.com/Linuus) for suggesting a viable way to pat
 
 ## Copyright
 
-Copyright (c) 2015 by [Giovanni Bellono](mailto://giovanni.bellono@gmail.com)<br>
+Copyright (c) 2015 by [Giovanni Bellono](mailto://giovanni.bellono@gmail.com)
+
 See [LICENSE](https://github.com/gbellono/localizer_rails/blob/master/MIT-LICENSE) for details.
 

data/lib/localizer_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: localizer_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - giovanni bellono
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-description: before_action method to set cascading best-match I18n.locale and method
-  to build the locale_menu
+description: Rails engine - sets I18n.locale through a best-match cascading search
+  and builds locale_menu (Bootstrap 3+ supported).
 email:
 - giovanni.bellono@gmail.com
 executables: []
@@ -327,5 +327,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Rails engine - set best-match I18n.locale and build locale_menu
+summary: Rails engine - sets best-match I18n.locale and builds locale_menu (Bootstrap
+  3+ supported).
 test_files: []