fast_gettext 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc6a0e04654cd2e6d0d6657d37f564a1472ec43e
-  data.tar.gz: 9843f87ded12215c6e1f3ae9a588170af7e01f97
+  metadata.gz: 8f4c80626231f0361be0e173421c4a1010c0a8d8
+  data.tar.gz: cbeb05b0da1df2944d4f7a7b48fc8bc85b540a27
 SHA512:
-  metadata.gz: b535e9e77d6e2237bfcafcf44612d1794748f749fb5d12bde658533116d75d4208f5f9621957d0f33dfdf93b9b9eadcb9bf6d6fda87389e5880167683cd9ebde
-  data.tar.gz: c3f7e9345eb928d017baa6c10041a23fb0811eb5e93d150dac786735cc219b32a3ad12e7d0e2641594a844e76afdc09ac63e116168e6213577b7f0075f8bac22
+  metadata.gz: 3f35ac017e58f1b0bdea6f3f3a0b32a4dc281806d4d6bfef0280bc96f953d19857038a70557d67e81146778a42996cfdfc6c9d7b40b92614e3b3a608e4e0f541
+  data.tar.gz: 11c9da7cf61ebe44f2be2e3e8da72318859c860a7edcc28ec5f624011bd0a79190ac4b21f0efb826a3adef8635e9485fcc39f23fabdb2b02b12681eb31e8860b

data/Readme.md

@@ -44,46 +44,60 @@ Setup
 =====
 ### 1. Install
 
-    sudo gem install fast_gettext
+```Bash
+gem install fast_gettext
+```
 
 ### 2. Add a translation repository
 
 From mo files (traditional/default)
 
-    FastGettext.add_text_domain('my_app', path: 'locale')
+```Ruby
+FastGettext.add_text_domain('my_app', path: 'locale')
+```
 
 Or po files (less maintenance than mo)
 
-    FastGettext.add_text_domain('my_app', path: 'locale', type: :po)
-    # :ignore_fuzzy => true to not use fuzzy translations
-    # :report_warning => false to hide warnings about obsolete/fuzzy translations
+```Ruby
+FastGettext.add_text_domain('my_app', path: 'locale', type: :po)
+# :ignore_fuzzy => true to not use fuzzy translations
+# :report_warning => false to hide warnings about obsolete/fuzzy translations
+```
 
 Or yaml files (use I18n syntax/indentation)
 
-    FastGettext.add_text_domain('my_app', path: 'config/locales', type: :yaml)
+```Ruby
+FastGettext.add_text_domain('my_app', path: 'config/locales', type: :yaml)
+```
 
 Or database (scaleable, good for many locales/translators)
 
-    # db access is cached <-> only first lookup hits the db
-    require "fast_gettext/translation_repository/db"
-    FastGettext::TranslationRepository::Db.require_models #load and include default models
-    FastGettext.add_text_domain('my_app', type: :db, model: TranslationKey)
+```Ruby
+# db access is cached <-> only first lookup hits the db
+require "fast_gettext/translation_repository/db"
+FastGettext::TranslationRepository::Db.require_models #load and include default models
+FastGettext.add_text_domain('my_app', type: :db, model: TranslationKey)
+```
 
 ### 3. Choose text domain and locale for translation
 Do this once in every Thread. (e.g. Rails -> ApplicationController)
 
-    FastGettext.text_domain = 'my_app'
-    FastGettext.available_locales = ['de','en','fr','en_US','en_UK'] # only allow these locales to be set (optional)
-    FastGettext.locale = 'de'
+```Ruby
+FastGettext.text_domain = 'my_app'
+FastGettext.available_locales = ['de','en','fr','en_US','en_UK'] # only allow these locales to be set (optional)
+FastGettext.locale = 'de'
+```
 
 ### 4. Start translating
 
-    include FastGettext::Translation
-    _('Car') == 'Auto'
-    _('not-found') == 'not-found'
-    s_('Namespace|not-found') == 'not-found'
-    n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
-    _('Hello %{name}!') % {name: "Pete"} == 'Hello Pete!'
+```Ruby
+include FastGettext::Translation
+_('Car') == 'Auto'
+_('not-found') == 'not-found'
+s_('Namespace|not-found') == 'not-found'
+n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
+_('Hello %{name}!') % {name: "Pete"} == 'Hello Pete!'
+```
 
 
 Managing translations
@@ -93,12 +107,14 @@ Generate .po or .mo files using GetText parser (example tasks at [gettext_i18n_r
 
 Tell Gettext where your .mo or .po files lie, e.g. for locale/de/my_app.po and locale/de/LC_MESSAGES/my_app.mo
 
-    FastGettext.add_text_domain('my_app', path: 'locale')
+```Ruby
+FastGettext.add_text_domain('my_app', path: 'locale')
+```
 
 Use the [original GetText](http://github.com/mutoh/gettext) to create and manage po/mo-files.
 (Work on a po/mo parser & reader that is easier to use has started, contributions welcome @ [get_pomo](http://github.com/grosser/get_pomo) )
 
-###Database
+### Database
 [Example migration for ActiveRecord](http://github.com/grosser/fast_gettext/blob/master/examples/db/migration.rb)<br/>
 The default plural seperator is `||||` but you may overwrite it (or suggest a better one..).
 
@@ -115,22 +131,24 @@ Try the [translation_db_engine](http://github.com/grosser/translation_db_engine)
 Setting `available_locales`,`text_domain` or `locale` will not work inside the `evironment.rb`,
 since it runs in a different thread then e.g. controllers, so set them inside your application_controller.
 
-    #environment.rb after initializers
-    Object.send(:include, FastGettext::Translation)
-    FastGettext.add_text_domain('accounting', path: 'locale')
-    FastGettext.add_text_domain('frontend', path: 'locale')
-    ...
-
-    #application_controller.rb
-    class ApplicationController ...
-      include FastGettext::Translation
-      before_filter :set_locale
-      def set_locale
-        FastGettext.available_locales = ['de','en',...]
-        FastGettext.text_domain = 'frontend'
-        FastGettext.set_locale(params[:locale] || session[:locale] || request.env['HTTP_ACCEPT_LANGUAGE'])
-        session[:locale] = I18n.locale = FastGettext.locale
-      end
+```Ruby
+# config/environment.rb after initializers
+Object.send(:include, FastGettext::Translation)
+FastGettext.add_text_domain('accounting', path: 'locale')
+FastGettext.add_text_domain('frontend', path: 'locale')
+...
+
+# app/controllers/application_controller.rb
+class ApplicationController ...
+  include FastGettext::Translation
+  before_filter :set_locale
+  def set_locale
+    FastGettext.available_locales = ['de','en',...]
+    FastGettext.text_domain = 'frontend'
+    FastGettext.set_locale(params[:locale] || session[:locale] || request.env['HTTP_ACCEPT_LANGUAGE'])
+    session[:locale] = I18n.locale = FastGettext.locale
+  end
+```
 
 
 Advanced features
@@ -142,102 +160,132 @@ If you have any languages that do not fit this rule, you have to add a custom pl
 
 Via Ruby:
 
-    FastGettext.pluralisation_rule = lambda{|count| count > 5 ? 1 : (count > 2 ? 0 : 2)}
+```Ruby
+FastGettext.pluralisation_rule = lambda{|count| count > 5 ? 1 : (count > 2 ? 0 : 2)}
+```
 
 Via mo/pofile:
 
-    Plural-Forms: nplurals=2; plural=n==2?3:4;
+```
+Plural-Forms: nplurals=2; plural=n==2?3:4;
+```
 
 [Plural expressions for all languages](http://translate.sourceforge.net/wiki/l10n/pluralforms).
 
-###default_text_domain
+### default_text_domain
 If you only use one text domain, setting `FastGettext.default_text_domain = 'app'`
 is sufficient and no more `text_domain=` is needed
 
-###default_locale
+### default_locale
 If the simple rule of "first `availble_locale` or 'en'" is not suficcient for you, set `FastGettext.default_locale = 'de'`.
 
-###default_available_locales
+### default_available_locales
 Fallback when no available_locales are set
 
-###Chains
+### with_locale
+If there is content from different locales that you wish to display, you should use the with_locale option as below:
+
+```Ruby
+FastGettext.with_locale 'gsw_CH' do
+  FastGettext._('Car was successfully created.')
+end
+# => "Z auto isch erfolgriich gspeicharat worda."
+```
+
+### Chains
 You can use any number of repositories to find a translation. Simply add them to a chain and when
 the first cannot translate a given key, the next is asked and so forth.
 
-    repos = [
-      FastGettext::TranslationRepository.build('new', path: '....'),
-      FastGettext::TranslationRepository.build('old', path: '....')
-    ]
-    FastGettext.add_text_domain 'combined', type: :chain, :chain: repos
+```Ruby
+repos = [
+  FastGettext::TranslationRepository.build('new', path: '....'),
+  FastGettext::TranslationRepository.build('old', path: '....')
+]
+FastGettext.add_text_domain 'combined', type: :chain, :chain: repos
+```
 
-###Merge
+### Merge
 In some cases you can benefit from using merge repositories as an alternative to chains. They behave nearly the same. The difference is in the internal
 data structure. While chain repos iterate over the whole chain for each translation, merge repositories select and store the first translation at the time
 a subordinate repository is added. This puts the burden on the load phase and speeds up the translations.
 
-    repos = [
-      FastGettext::TranslationRepository.build('new', :path: '....'),
-      FastGettext::TranslationRepository.build('old', :path: '....')
-    ]
-    domain = FastGettext.add_text_domain 'combined', type: :merge, chain: repos
+```Ruby
+repos = [
+  FastGettext::TranslationRepository.build('new', :path: '....'),
+  FastGettext::TranslationRepository.build('old', :path: '....')
+]
+domain = FastGettext.add_text_domain 'combined', type: :merge, chain: repos
+```
 
 Downside of this approach is that you have to reload the merge repo each time a language is changed.
 
-    FastGettext.locale = 'de'
-    domain.reload
+```Ruby
+FastGettext.locale = 'de'
+domain.reload
+```
 
-###Logger
+### Logger
 When you want to know which keys could not be translated or were used, add a Logger to a Chain:
 
-    repos = [
-      FastGettext::TranslationRepository.build('app', path: '....')
-      FastGettext::TranslationRepository.build('logger', type: :logger, callback: lambda{|key_or_array_of_ids| ... }),
-    }
-    FastGettext.add_text_domain 'combined', type: :chain, chain: repos
+```Ruby
+repos = [
+  FastGettext::TranslationRepository.build('app', path: '....')
+  FastGettext::TranslationRepository.build('logger', type: :logger, callback: lambda{|key_or_array_of_ids| ... }),
+}
+FastGettext.add_text_domain 'combined', type: :chain, chain: repos
+```
 
 If the Logger is in position #1 it will see all translations, if it is in position #2 it will only see the unfound.
 Unfound may not always mean missing, if you choose not to translate a word because the key is a good translation, it will appear nevertheless.
 A lambda or anything that responds to `call` will do as callback. A good starting point may be `examples/missing_translations_logger.rb`.
 
-###Plugins
+### Plugins
 Want a xml version ?
 Write your own TranslationRepository!
 
-    #fast_gettext/translation_repository/xxx.rb
-    module FastGettext
-      module TranslationRepository
-        class Wtf
-          define initialize(name,options), [key], plural(*keys) and
-          either inherit from TranslationRepository::Base or define available_locales and pluralisation_rule
-        end
-      end
+```Ruby
+# fast_gettext/translation_repository/xxx.rb
+module FastGettext
+  module TranslationRepository
+    class Wtf
+      define initialize(name,options), [key], plural(*keys) and
+      either inherit from TranslationRepository::Base or define available_locales and pluralisation_rule
     end
+  end
+end
+```
 
-###Multi domain support
+### Multi domain support
 
 If you have more than one gettext domain, there are two sets of functions
 available:
 
-    include FastGettext::TranslationMultidomain
+```Ruby
+include FastGettext::TranslationMultidomain
 
-    d_("domainname", "string") # finds 'string' in domain domainname
-    dn_("domainname", "string", "strings", 1) # ditto
-    # etc.
+d_("domainname", "string") # finds 'string' in domain domainname
+dn_("domainname", "string", "strings", 1) # ditto
+# etc.
+```
 
 These are helper methods so you don't need to write:
 
-    FastGettext.text_domain = "domainname"
-    _("string")
+```Ruby
+FastGettext.text_domain = "domainname"
+_("string")
+```
 
 It is useful in Rails plugins in the views for example. The second set of
 functions are D functions which search for string in _all_ domains. If there
 are multiple translations in different domains, it returns them in random
 order (depends on the Ruby hash implementation):
 
-    include FastGettext::TranslationMultidomain
+```Ruby
+include FastGettext::TranslationMultidomain
 
-    D_("string") # finds 'string' in any domain
-    # etc.
+D_("string") # finds 'string' in any domain
+# etc.
+```
 
 Alternatively you can use [merge repository](https://github.com/grosser/fast_gettext#merge) to achieve the same behaviour.
 
@@ -274,6 +322,7 @@ Mo/Po-file parsing from Masao Mutoh, see vendor/README
  - [Lukáš Zapletal](https://github.com/lzap)
  - [Dominic Cleal](https://github.com/domcleal)
  - [Tomas Strachota](https://github.com/tstrachota)
+ - [Martin Meier](https://github.com/mameier)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/lib/fast_gettext/translation_repository/base.rb

@@ -4,6 +4,9 @@ module FastGettext
     #  - base for all repositories
     #  - fallback as empty repository, that cannot translate anything but does not crash
     class Base
+
+      attr_reader :name, :options
+
       def initialize(name,options={})
         @name = name
         @options = options

data/lib/fast_gettext/version.rb

@@ -1,3 +1,3 @@
 module FastGettext
-  VERSION = Version = '1.3.0'
+  VERSION = Version = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_gettext
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake