i18n-bamboo 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cfd6e263d8c6757068d359b5051c93e90a6ceb2
-  data.tar.gz: 3e625ee1a048a3da2a172f16b136837ea6ad4eab
+  metadata.gz: e1ed871413db5574b95cef0cd50a9e140fa4b235
+  data.tar.gz: ef51776267eee5b61a32ef40e879f7e319f53163
 SHA512:
-  metadata.gz: 48ae9eaca6ebcfa6145edf982ba192a658028d27fadf28c54508698b0a4cc20646f468d4be670326ca6a9118ce370f9fa9598a432973be30e8e3fc49cc156208
-  data.tar.gz: 53313d4621b421ec4557d2842cbb85ebba71afb1375ec443af0eaa151d14e8a0b8f8a38f8719872a82383e4bf86687f83685d2f19ffeb946c0161d0faa06406a
+  metadata.gz: b0095145aa0daa4b811eaecaad11ee013f380c50dac20b225bc1ffdf70494172992f9dbd84d324e3d9ca012aa65d4c2411a7ca8f18fa8aed742181c9cc3b6c54
+  data.tar.gz: 9baade06a8872c029bd464998dc347367cde7c45ddbe5c1732d3eec55cbea20f1c5a34a036c935d3a247db3ef80197cbc5ce4abc60aa178e1c9a8f90507b614c

data/README.md

@@ -50,6 +50,16 @@ I18n.t('bird')
 # => "Feathered Friend"
 ```
 
+Additionally, you can temporarily override this new behavior of the `translate` and `localize` methods by passing in the `:force_default_behavior` option.
+
+```ruby
+# Assume that I18n.default_locale = :en
+I18n.t('car', force_default_behavior: true)
+# => "Car"
+I18n.t('car', force_default_behavior: false)
+# => "Automobil"
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/i18n/bamboo/fertilizer.rb

@@ -8,13 +8,25 @@ module I18n
           alias_method :original_translate, :translate
           alias_method :original_localize, :localize
 
+          # Public: Unless overridden, translates using the longest translation from among all available locales.
+          #
+          # *args   - see http://goo.gl/vSpFKl for original method argument doc
+          # options - The final argument can optionally be a Hash of options
+          #           :force_default_behavior - Boolean that determines whether or not to force the default translate
+          #                                   behavior
+          #
+          # Returns the longest translated String.
           def translate(*args)
+            # Fall back to the default translate behavior if the :force_default_behavior is true
+            force_current_locale  = args.last.is_a?(Hash) ? args.pop.delete(:force_default_behavior) : false
+            return original_translate(*args) if force_current_locale
+
             translations = []
 
             available_locales.each do |locale|
               args_copy = args.dup
 
-              if args_copy.last.is_a? Hash
+              if args_copy.last.is_a?(Hash)
                 args_copy.last.merge!(locale: locale)
               else
                 args_copy << {locale: locale}
@@ -26,7 +38,19 @@ module I18n
             translations.max
           end
 
+          # Public: Unless overridden, translates using the longest localized value from among all available locales.
+          #
+          # object  - see http://goo.gl/bbXILw for original method argument doc
+          # options - see http://goo.gl/bbXILw for original method argument doc.  This Hash can can contain the
+          #           the following custom key:
+          #           :force_default_behavior - Boolean that determines whether or not to force the default localize
+          #                                   behavior
+          #
+          # Returns the longest localized String.
           def localize(object, options = {})
+            # Fall back to the default localize behavior if the :force_default_behavior is true
+            return original_localize(object, options) if options.delete(:force_default_behavior)
+
             localized_values = []
 
             available_locales.each do |locale|

data/lib/i18n/bamboo/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Bamboo
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/i18n/bamboo/fertilizer_spec.rb

@@ -19,66 +19,202 @@ RSpec.describe 'I18n monkey patching' do
   end
 
   describe '#translate' do
-    before do
-      expect(I18n).to receive(:original_translate)
-        .with(key, {locale: :en})
-        .and_return(short_translation)
-
-      expect(I18n).to receive(:original_translate)
-        .with(key, {locale: :zh})
-        .and_return(long_translation)
+    context 'when the :force_default_behavior option is passed in' do
+      context 'when :force_default_behavior is true' do
+        before do
+          expect(I18n).to receive(:original_translate).with(key).and_return(short_translation)
+          expect(I18n).not_to receive(:original_translate).with(key, locale: :en)
+          expect(I18n).not_to receive(:original_translate).with(key, locale: :zh)
+        end
+
+        it 'calls through to original_translate without modifying its arguments and returns the translation' do
+          expect(I18n.translate(key, force_default_behavior: true)).to eq(short_translation)
+        end
+      end
+
+      context 'when :force_default_behavior is false' do
+        before do
+          expect(I18n).not_to receive(:original_translate).with(key)
+          expect(I18n).to receive(:original_translate)
+            .with(key, locale: :en)
+            .and_return(short_translation)
+
+          expect(I18n).to receive(:original_translate)
+            .with(key, locale: :zh)
+            .and_return(long_translation)
+        end
+
+        it 'returns the longest translation from all available locales' do
+          expect(I18n.translate(key, force_default_behavior: false)).to eq(long_translation)
+        end
+      end
     end
 
-    it 'returns the longest translation' do
-      expect(I18n.translate(key)).to eq(long_translation)
+    context 'when the :force_default_behavior option is not passed in' do
+      before do
+        expect(I18n).not_to receive(:original_translate).with(key)
+        expect(I18n).to receive(:original_translate)
+          .with(key, locale: :en)
+          .and_return(short_translation)
+
+        expect(I18n).to receive(:original_translate)
+          .with(key, locale: :zh)
+          .and_return(long_translation)
+      end
+
+      it 'returns the longest translation from all available locales' do
+        expect(I18n.translate(key)).to eq(long_translation)
+      end
     end
   end
 
   describe '#t' do
-    before do
-      expect(I18n).to receive(:original_translate)
-        .with(key, {locale: :en})
-        .and_return(short_translation)
-
-      expect(I18n).to receive(:original_translate)
-        .with(key, {locale: :zh})
-        .and_return(long_translation)
+    context 'when the :force_default_behavior option is passed in' do
+      context 'when :force_default_behavior is true' do
+        before do
+          expect(I18n).to receive(:original_translate).with(key).and_return(short_translation)
+          expect(I18n).not_to receive(:original_translate).with(key, locale: :en)
+          expect(I18n).not_to receive(:original_translate).with(key, locale: :zh)
+        end
+
+        it 'calls through to original_translate without modifying its arguments and returns the translation' do
+          expect(I18n.t(key, force_default_behavior: true)).to eq(short_translation)
+        end
+      end
+
+      context 'when :force_default_behavior is false' do
+        before do
+          expect(I18n).not_to receive(:original_translate).with(key)
+          expect(I18n).to receive(:original_translate)
+            .with(key, locale: :en)
+            .and_return(short_translation)
+
+          expect(I18n).to receive(:original_translate)
+            .with(key, locale: :zh)
+            .and_return(long_translation)
+        end
+
+        it 'returns the longest translation from all available locales' do
+          expect(I18n.t(key, force_default_behavior: false)).to eq(long_translation)
+        end
+      end
     end
 
-    it 'returns the longest translation' do
-      expect(I18n.t(key)).to eq(long_translation)
+    context 'when the :force_default_behavior option is not passed in' do
+      before do
+        expect(I18n).not_to receive(:original_translate).with(key)
+        expect(I18n).to receive(:original_translate)
+          .with(key, locale: :en)
+          .and_return(short_translation)
+
+        expect(I18n).to receive(:original_translate)
+          .with(key, locale: :zh)
+          .and_return(long_translation)
+      end
+
+      it 'returns the longest translation from all available locales' do
+        expect(I18n.translate(key)).to eq(long_translation)
+      end
     end
   end
 
   describe '#localize' do
-    before do
-      expect(I18n).to receive(:original_localize)
-        .with(time, {locale: :en})
-        .and_return(short_time)
-
-      expect(I18n).to receive(:original_localize)
-        .with(time, {locale: :zh})
-        .and_return(long_time)
+    context 'when the :force_default_behavior option is passed in' do
+      context 'when :force_default_behavior is true' do
+        before do
+          expect(I18n).to receive(:original_localize).with(time, {}).and_return(short_time)
+          expect(I18n).not_to receive(:original_localize).with(time, locale: :en)
+          expect(I18n).not_to receive(:original_localize).with(time, locale: :zh)
+        end
+
+        it 'calls through to original_localize without modifying its arguments and returns the localized value' do
+          expect(I18n.localize(time, force_default_behavior: true)).to eq(short_time)
+        end
+      end
+
+      context 'when :force_default_behavior is false' do
+        before do
+          expect(I18n).not_to receive(:original_localize).with(time)
+          expect(I18n).to receive(:original_localize)
+            .with(time, locale: :en)
+            .and_return(short_time)
+
+          expect(I18n).to receive(:original_localize)
+            .with(time, locale: :zh)
+            .and_return(long_time)
+        end
+
+        it 'returns the longest localized value from all available locales' do
+          expect(I18n.localize(time, force_default_behavior: false)).to eq(long_time)
+        end
+      end
     end
 
-    it 'returns the longest translation' do
-      expect(I18n.localize(time)).to eq(long_time)
+    context 'when the :force_default_behavior option is not passed in' do
+      before do
+        expect(I18n).not_to receive(:original_localize).with(time)
+        expect(I18n).to receive(:original_localize)
+          .with(time, locale: :en)
+          .and_return(short_time)
+
+        expect(I18n).to receive(:original_localize)
+          .with(time, locale: :zh)
+          .and_return(long_time)
+      end
+
+      it 'returns the longest translation from all available locales' do
+        expect(I18n.localize(time)).to eq(long_time)
+      end
     end
   end
 
   describe '#l' do
-    before do
-      expect(I18n).to receive(:original_localize)
-        .with(time, {locale: :en})
-        .and_return(short_time)
-
-      expect(I18n).to receive(:original_localize)
-        .with(time, {locale: :zh})
-        .and_return(long_time)
+    context 'when the :force_default_behavior option is passed in' do
+      context 'when :force_default_behavior is true' do
+        before do
+          expect(I18n).to receive(:original_localize).with(time, {}).and_return(short_time)
+          expect(I18n).not_to receive(:original_localize).with(time, locale: :en)
+          expect(I18n).not_to receive(:original_localize).with(time, locale: :zh)
+        end
+
+        it 'calls through to original_localize without modifying its arguments and returns the localized value' do
+          expect(I18n.l(time, force_default_behavior: true)).to eq(short_time)
+        end
+      end
+
+      context 'when :force_default_behavior is false' do
+        before do
+          expect(I18n).not_to receive(:original_localize).with(time)
+          expect(I18n).to receive(:original_localize)
+            .with(time, locale: :en)
+            .and_return(short_time)
+
+          expect(I18n).to receive(:original_localize)
+            .with(time, locale: :zh)
+            .and_return(long_time)
+        end
+
+        it 'returns the longest localized value from all available locales' do
+          expect(I18n.l(time, force_default_behavior: false)).to eq(long_time)
+        end
+      end
     end
 
-    it 'returns the longest translation' do
-      expect(I18n.l(time)).to eq(long_time)
+    context 'when the :force_default_behavior option is not passed in' do
+      before do
+        expect(I18n).not_to receive(:original_localize).with(time)
+        expect(I18n).to receive(:original_localize)
+          .with(time, locale: :en)
+          .and_return(short_time)
+
+        expect(I18n).to receive(:original_localize)
+          .with(time, locale: :zh)
+          .and_return(long_time)
+      end
+
+      it 'returns the longest translation from all available locales' do
+        expect(I18n.l(time)).to eq(long_time)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-bamboo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Downey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n