transilator 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f307d208407e582599a82f7087be239bee6eff
-  data.tar.gz: bc0b12cfc8bef47f6dec48ba279240d3b1f78a3f
+  metadata.gz: 4ca38e76b1e55e598e90bf1f09d4bba64d82bb5f
+  data.tar.gz: 7aed382a01858d6d9c7ed3d865cc088448b134a5
 SHA512:
-  metadata.gz: c8fd2cc1f2ffc891f6425fd1721a20195c866e08aaa0b4abdddcb7129aac3444e92a9e90b42aed25c2882b21a0c32f9df95650a5095d0bf316a7924203f2d0ae
-  data.tar.gz: 8e8493a064a3b744b2a0ab86cec181440d03d3b50ab6256eff82e7b91bda1db6b3d481dad1b29b10b12ee0c2c49d0561489bea8e053968ff5ad31421f161a226
+  metadata.gz: a03646844e4bc24feb1757d15a5f927de6b18e13a77ad5abcf6ceb70c0d264e18b1a0237b9322268e0b7bce2f34418477f8428c75b58784bb59a55714bf89bf7
+  data.tar.gz: 2e3da9b600c787519a73abc2701f5ac09d39941361cd2dcffceb2bda329ebf34cb2aaa636b9ac684363ab489c3f211adad5ee27b5e6c34f3a391d71f4bf789fa

data/README.md

@@ -1,6 +1,6 @@
 # Transilator
 
-[![Build Status](https://travis-ci.org/hendricius/transilator.svg?branch=master)](https://travis-ci.org/hendricius/transilator)
+[![CircleCI](https://circleci.com/gh/hendricius/transilator.svg?style=svg)](https://circleci.com/gh/hendricius/transilator)
 
 Transilator makes storing translations for database records painless.
 
@@ -32,11 +32,11 @@ You may need to create migration for your model as usual. Assuming you have no
 table yet, create the table:
 
 ```ruby
-  create_table :posts do |t|
-    t.hstore :title  # note for this to work you need to enable the hstore extension in your database.
-    t.jsonb :summary # this is the suggested way.
-    t.timestamps
-  end
+create_table :posts do |t|
+  t.hstore :title  # note for this to work you need to enable the hstore extension in your database.
+  t.jsonb :summary # this is the suggested way.
+  t.timestamps
+end
 ```
 
 Then adjust your model and integrate transilator:
@@ -49,6 +49,8 @@ end
 
 Thats it!
 
+**Basic usage**
+
 Now you are able to translate values for the attributes :title and :description per locale:
 
 ```ruby
@@ -71,10 +73,28 @@ post.title_en = 'I have no idea what I am doing'
 post.title_en #=> I have no idea what I am doing
 ```
 
+You can pass the values directly during initialisation of an object:
+```ruby
+Post.new(title: {en: 'The German', de: 'Serr German'})
+```
+
+**Fallbacks**
+
+You can setup fallbacks in case you are missing data from one language. Then
+the next language is used based on the order in the fallbacks array.
+
+Create an initializer `initializers/transilator.rb` in your rails app.
+
+```ruby
+Transilator.configure do |config|
+  config.locale_fallbacks = { "de" => ["en", "at"] }
+end
+```
 
-You may use initialization if needed:
+Now in case we wouldn't have a German translation we fallback to English. If
+we have no English translation then we will proceed and try our Austrian
+translation. If that doesn't work then empty string is returned.
 
-    Post.new(title: {en: 'The German', de: 'Serr German'})
 
 ## Performance ##
 

data/lib/transilator.rb

@@ -2,4 +2,31 @@ require "transilator/version"
 require "transilator/active_record_extensions"
 
 module Transilator
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # returns the config object
+  def self.config
+    self.configuration = Configuration.new unless self.configuration
+    self.configuration
+  end
+
+  class Configuration
+    attr_accessor :locale_fallbacks
+
+    def initialize
+      @locale_fallbacks = {}
+    end
+
+    # returns an array with fallbacks for the given locale
+    def get_fallbacks_for_locale(locale)
+      locale_fallbacks[locale] || []
+    end
+  end
 end

data/lib/transilator/active_record_extensions.rb

@@ -5,14 +5,26 @@ module Transilator
 
       def transilator(*args)
 
-
         args.each do |attribute|
 
           # read the attribute from the hstore attribute and return it.
           #
           # returns the attribute or an empty string if the attribute is nil
           define_method attribute do
-            (self[attribute] || {})[I18n.locale.to_s] || ""
+            locale = I18n.locale.to_s
+            attribute_value_hash = (self[attribute] || {})
+            value = (attribute_value_hash)[locale] || ""
+            # we have a value, so let's abort.
+            return value unless value.empty?
+            # now implement our fallback mechanism
+            fallbacks_for_locale  = Transilator.config.get_fallbacks_for_locale(locale)
+            return value if fallbacks_for_locale.empty?
+            # now do the magic for figuring out the fallback
+            fallback_locale_to_use = fallbacks_for_locale.find {|f| (attribute_value_hash)[f] }
+            # no fallback that can be used found.
+            return "" unless fallback_locale_to_use
+            # return our value or an empty string
+            attribute_value_hash[fallback_locale_to_use] || ""
           end
 
           # set the attribute on the model on the hstore hash

data/lib/transilator/version.rb

@@ -1,3 +1,3 @@
 module Transilator
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transilator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Hendrik Kleinwaechter