air18n 0.1.3 → 0.1.4

data/lib/air18n/backend.rb

@@ -8,7 +8,13 @@ module Air18n
   class Backend
     include I18n::Backend::Base
 
-    attr_accessor :translation_data, :initialized, :phrase_screenshots
+    # - translation_data: map of locale to key to translation
+    # - phrase_screenshots: map of phrase key to the routes context that we
+    #   have screenshots for
+    # - default_text_change_observer: set this to an implementation of
+    #   DefaultTextChangeObserver to be alerted to changes of default text, and
+    #   be able to guard against flipflops.
+    attr_accessor :translation_data, :phrase_screenshots, :default_text_change_observer
 
     # Stores translations for a given locale.
     def store_translations locale, data, options = {}
@@ -157,27 +163,34 @@ module Air18n
       if locale == I18n.default_locale && default && result != default
         # If it doesn't, we need to update the 'phrases' table so that
         # the 'value' column reflects the latest English default text.
+        store_default = true
         if result.present?
-          LoggingHelper.info "Default #{I18n.default_locale} text for key '#{key}' changed! Old default '#{result}' != new default '#{default}'. Route context: #{options[:routes_context]}"
+          LoggingHelper.info "Default #{locale} text for key '#{key}' changed! Old default '#{result}' != new default '#{default}'. Route context: #{options[:routes_context]}"
+          if @default_text_change_observer.present?
+            @default_text_change_observer.default_text_changed(locale, key, result, default)
+            store_default = @default_text_change_observer.allow_default_text_change?(locale, key, result, default)
+          end
         end
-        phrase = Phrase.find_or_create_by_key(key)
-        if phrase
-          if (overrides_previous_default && phrase.value != default) ||
-            (!overrides_previous_default && phrase.value != default && phrase.value.blank?)
-            phrase.value = default
-
-            begin
-              phrase.save
-            rescue Exception => e
-              # If many requests happen simultaneously for a page with a new
-              # phrase, a "duplicate entry" exception will happen naturally.
-              # And if phrase creation fails for some other reason, we will try
-              # again to create it next time automatically.
+        if store_default
+          phrase = Phrase.find_or_create_by_key(key)
+          if phrase
+            if (overrides_previous_default && phrase.value != default) ||
+              (!overrides_previous_default && phrase.value != default && phrase.value.blank?)
+              phrase.value = default
+
+              begin
+                phrase.save
+              rescue Exception => e
+                # If many requests happen simultaneously for a page with a new
+                # phrase, a "duplicate entry" exception will happen naturally.
+                # And if phrase creation fails for some other reason, we will try
+                # again to create it next time automatically.
+              end
             end
           end
-        end
 
-        @translation_data[locale][key] = default
+          @translation_data[locale][key] = default
+        end
         result = default
       end
 

data/lib/air18n/class_methods.rb

@@ -178,6 +178,10 @@ module Air18n
       @air18n_backend.rescreenshot(routes_context)
     end
 
+    def set_default_text_change_observer(observer)
+      @air18n_backend.default_text_change_observer = observer
+    end
+
     def currency=(c)
       @currency = c
       @distance_unit = self::MILES_CURRENCIES.include?(c) ? "MI" : "KM"

data/lib/air18n/version.rb

@@ -1,3 +1,3 @@
 module Air18n
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/air18n.rb

@@ -5,6 +5,7 @@ require 'active_record'
 require 'air18n/class_methods'
 require 'air18n/backend'
 require 'air18n/priority'
+require 'air18n/default_text_change_observer'
 
 require 'air18n/reflection'
 

data/make_gem

@@ -1,5 +1,5 @@
 # Run this to push the new version of the gem to rubygems!
-v=0.1.3
+v=0.1.4
 gem build air18n.gemspec
 gem push air18n-${v}.gem
 

data/spec/lib/air18n/backend_spec.rb

@@ -4,6 +4,19 @@ require 'air18n/mock_priority'
 
 describe Air18n::Backend do
 
+  class PessimisticRecordingDefaultTextChangeObserver
+    extend Air18n::DefaultTextChangeObserver
+    attr_accessor :changes
+    def default_text_changed(locale, key, old_default, new_default)
+      @changes ||= []
+      @changes << [locale, key, old_default, new_default]
+    end
+
+    def allow_default_text_change?(locale, key, old_default, new_default)
+      false
+    end
+  end
+
   before do
     @scope = []
   end
@@ -31,6 +44,16 @@ describe Air18n::Backend do
       @backend.lookup(I18n.default_locale, phrase.key, @scope, :default => 'new_value', :default_is_low_priority => true).should == 'new_value'
       phrase.reload.value.should == 'original_value'
     end
+    it 'Should not override DB value when default text observer says not to' do
+      phrase = FactoryGirl.create(:phrase, :key => 'default text change, key 1', :value => 'original_value')
+      @backend.init_translations(I18n.default_locale)
+      default_text_change_observer = PessimisticRecordingDefaultTextChangeObserver.new
+      @backend.default_text_change_observer = default_text_change_observer
+      @backend.lookup(I18n.default_locale, phrase.key, @scope, :default => 'new_value').should == 'new_value'
+
+      default_text_change_observer.changes.should == [[:en, 'default text change, key 1', 'original_value', 'new_value']]
+      phrase.reload.value.should == 'original_value'
+    end
   end
 
   context 'Robustness to various input formats' do

data/spec/lib/air18n/phrase_translation_spec.rb

@@ -30,9 +30,6 @@ describe Air18n::PhraseTranslation do
       translation.value = 'too looooong'
       translation.save.should be_false
       translation.errors.should == { :value => ["Translation has 12 characters; maximum length 10 characters."] }
-
-      translation = FactoryGirl.create(:phrase_translation, :key => 'facebook description maxlength:0', :value => 'short')
-      validated = translation.save
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: air18n
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors: