localeapp 0.6.9 → 0.6.10

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# master
+
+# Version 0.6.10
+
+* Don't send the :default param with a MissingTranslation when not in
+  the default locale.
+* Cache MissingTranslations so that they're not sent multiple times.
+
+# Version 0.6.9
+
+* Make rack a dependency as we actually use it (Thanks @martoche)
+
 # Version 0.6.8
 
 * Don't load any yaml that may contain insecure content

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubyforge
+source 'https://rubygems.org'
 gemspec
 
 platform :jruby do

data/Gemfile.i18n_037

@@ -1,4 +1,4 @@
-source :rubyforge
+source 'https://rubygems.org'
 gemspec
 
 gem 'i18n', '0.3.7'

data/Gemfile.i18n_050

@@ -1,4 +1,4 @@
-source :rubyforge
+source 'https://rubygems.org'
 gemspec
 
 gem 'i18n', '0.5.0'

data/Gemfile.i18n_060

@@ -1,4 +1,4 @@
-source :rubyforge
+source 'https://rubygems.org'
 gemspec
 
 gem 'i18n', '~> 0.6.0'

data/README.md

@@ -79,8 +79,9 @@ existing translations do:
 This will queue importing the file. The projects pages on localeapp.com will
 automatically refresh so you can see the import progress.
 
-If you've more than one locale to import you can zip up the yml files. Both
-localeapp.com and the localeapp import command accept zip files.
+If you've more than one locale to import you can import all files in a directory :
+
+    localeapp push config/locales/
 
 ## Default Rails Translations
 
@@ -153,6 +154,13 @@ can be disabled in a similar way to polling and sending:
 
     config.reloading_environments = []
 
+### Caching
+
+To prevent localeapp from sending translations every time they are missing,
+add this config setting:
+
+    config.cache_missing_translations = true
+
 ## Inviting other developers and translators
 
 You can invite other developers and translators via localeapp.com.  Developers

data/lib/localeapp/configuration.rb

@@ -74,6 +74,10 @@ module Localeapp
     # default: true
     attr_accessor :raise_on_insecure_yaml
 
+    # Enable or disable the missing translation cache
+    # default: false
+    attr_accessor :cache_missing_translations
+
     def initialize
       defaults.each do |setting, value|
         send("#{setting}=", value)

data/lib/localeapp/default_value_handler.rb

@@ -4,10 +4,11 @@ module I18n::Backend::Base
   def default(locale, object, subject, options = {})
     result = default_without_handler(locale, object, subject, options)
     case subject # case is what i18n gem uses here so doing the same
-    when Array
+    when Array, Symbol
       # Do nothing, we only send missing translations with text defaults
     else
-      Localeapp.missing_translations.add(locale, object, subject, options)
+      value = locale == I18n.default_locale ? subject : nil
+      Localeapp.missing_translations.add(locale, object, value, options)
     end
     return result
   end

data/lib/localeapp/missing_translations.rb

@@ -2,6 +2,12 @@ module Localeapp
   MissingTranslationRecord = Struct.new(:key, :locale, :description, :options)
 
   class MissingTranslations
+    @cached_keys = []
+
+    class << self
+      attr_accessor :cached_keys
+    end
+
     def initialize
       @translations = Hash.new { |h, k| h[k] = {} }
     end
@@ -15,23 +21,33 @@ module Localeapp
       @translations[locale]
     end
 
-    # This method will get cleverer so we don't resend keys we've
-    # already sent, or send multiple times for the same locale etc.
-    # For now it's pretty dumb
     def to_send
       data = []
       # need the sort to make specs work under 1.8
       @translations.sort { |a, b| a.to_s <=> b.to_s }.each do |locale, records|
         records.each do |key, record|
-          missing_data = {}
-          missing_data[:key] = key
-          missing_data[:locale] = locale
+          next if cached?(key)
+          cache(key)
+          missing_data = {:key => key, :locale => locale, :options => record.options}
           missing_data[:description] = record.description if record.description
-          missing_data[:options] = record.options
           data << missing_data
         end
       end
       data
     end
+
+    private
+
+    def cached_keys
+      self.class.cached_keys
+    end
+
+    def cached?(key)
+      Localeapp.configuration.cache_missing_translations && cached_keys.include?(key)
+    end
+
+    def cache(key)
+      cached_keys << key if Localeapp.configuration.cache_missing_translations
+    end
   end
 end

data/lib/localeapp/updater.rb

@@ -43,7 +43,7 @@ module Localeapp
     private
 
     def generate_yaml(translations)
-      if defined? Psych
+      if defined?(Psych) && defined?(Psych::VERSION)
         Psych.dump(translations, :line_width => -1)[4..-1].sub(/\.\.\.\n$/, '')
       else
         translations.ya2yaml[5..-1]

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = "0.6.9"
+  VERSION = "0.6.10"
 end

data/localeapp.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |s|
   s.add_dependency('i18n')
   s.add_dependency('json')
   s.add_dependency('rest-client')
+  s.add_dependency('rack')
   s.add_dependency('ya2yaml')
   s.add_dependency('gli')
 
   s.add_development_dependency('rake')
-  s.add_development_dependency('rack')
   s.add_development_dependency('rspec', '2.11.0')
   s.add_development_dependency('yard', '0.6.7')
   s.add_development_dependency('RedCloth', '4.2.9')

data/spec/localeapp/default_value_handler_spec.rb

@@ -7,26 +7,46 @@ end
 describe I18n::Backend::Base, '#default' do
   let(:klass) { Klass.new }
 
-  it "adds translations to missing translations to send to Locale" do
+  def allow_sending
     with_configuration(:sending_environments => ['my_env'], :environment_name => 'my_env' ) do
-      Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', 'bar', :baz => 'bam')
-      klass.default(:en, 'foo', 'bar', :baz => 'bam')
+      yield
     end
   end
 
-  describe "when subject is an array" do
-    it "doesn't send anything" do
-      with_configuration(:sending_environments => ['my_env'], :environment_name => 'my_env' ) do
-        Localeapp.missing_translations.should_not_receive(:add).with(:en, 'foo', 'not missing', :baz => 'bam')
+  describe "when subject is a String" do
+    it "adds translations to missing translations to send to Locale" do
+      allow_sending do
+        Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', 'bar', :baz => 'bam')
+        klass.default(:en, 'foo', 'bar', :baz => 'bam')
+      end
+    end
+
+    it "strips the subject when the translation is not in the default locale" do
+      allow_sending do
+        Localeapp.missing_translations.should_receive(:add).with(:fr, 'foo', nil, :baz => 'bam')
+        klass.default(:fr, 'foo', 'bar', :baz => 'bam')
+      end
+    end
+  end
+
+  describe "when subject is an Array" do
+    it "doesn't send anything to Locale" do
+      allow_sending do
+        Localeapp.missing_translations.should_not_receive(:add)
         I18n.stub!(:translate) do |subject, _|
-          if subject == :not_missing
-            "not missing"
-          else
-            nil
-          end
+          subject == :not_missing ? "not missing" : nil
         end
         klass.default(:en, 'foo', [:missing, :not_missing], :baz => 'bam')
       end
     end
   end
+
+  describe "when subject is a Symbol" do
+    it "doesn't send anything to Locale" do
+      allow_sending do
+        Localeapp.missing_translations.should_not_receive(:add)
+        klass.default(:en, 'foo', :other_key, :baz => 'bam')
+      end
+    end
+  end
 end

data/spec/localeapp/exception_handler_spec.rb

@@ -19,6 +19,17 @@ describe Localeapp::ExceptionHandler, '#call(exception, locale, key, options)' d
     I18n.t(['foo', 'bar'])
   end
 
+  it "handles when the default is a Symbol that can be resolved" do
+    I18n.backend.store_translations(:en, {:default_symbol_test => 'is resolved'})
+    Localeapp.missing_translations.should_not_receive(:add)
+    I18n.t(:foo, :default => :default_symbol_test).should == 'is resolved'
+  end
+
+  it "handles when the default is a Symbol that can't be resolved" do
+    Localeapp.missing_translations.should_receive(:add).with(:en, :foo, nil, {:default => :bar})
+    I18n.t(:foo, :default => :bar)
+  end
+
   it "handles missing translation exception" do
     expect {
       exception = Localeapp::I18nMissingTranslationException.new(:en, 'foo', {})

data/spec/localeapp/missing_translations_spec.rb

@@ -28,4 +28,28 @@ describe Localeapp::MissingTranslations, "#to_send" do
     to_send[1][:description].should == 'baz'
     to_send[1][:options].should == {}
   end
+
+  it "doesn't send the same key twice when cache_missing_translations is true" do
+    with_configuration(:cache_missing_translations => true) do
+      translation_a = Localeapp::MissingTranslations.new
+      translation_a.add(:es, 'foobybar')
+      translation_a.to_send.size.should == 1
+
+      translation_b = Localeapp::MissingTranslations.new
+      translation_b.add(:en, 'foobybar')
+      translation_a.to_send.size.should == 0
+    end
+  end
+
+  it "can send the same key twice when cache_missing_translations is false" do
+    with_configuration(:cache_missing_translations => false) do
+      translation_a = Localeapp::MissingTranslations.new
+      translation_a.add(:es, 'foobybar')
+      translation_a.to_send.size.should == 1
+
+      translation_b = Localeapp::MissingTranslations.new
+      translation_b.add(:en, 'foobybar')
+      translation_a.to_send.size.should == 1
+    end
+  end
 end

data/spec/localeapp/updater_spec.rb

@@ -98,7 +98,7 @@ describe Localeapp::Updater, ".update(data)" do
     File.exist?(File.join(@yml_dir, 'ja.yml')).should be_false
   end
 
-  if defined?(Psych) && Psych::VERSION >= "1.1.0" && !RUBY_PLATFORM == 'jruby'
+  if defined?(Psych) && defined?(Psych::VERSION) && Psych::VERSION >= "1.1.0" && !RUBY_PLATFORM == 'jruby'
     it "doesn't try to wrap long lines in the output" do
       do_update({
         'translations' => {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: localeapp
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 6
-  - 9
-  version: 0.6.9
+  - 10
+  version: 0.6.10
 platform: ruby
 authors: 
 - Christopher Dell
@@ -16,10 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-15 00:00:00 Z
+date: 2013-06-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: i18n
+  type: :runtime
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,11 +31,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id001
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,11 +45,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id002
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: rest-client
+  type: :runtime
+  prerelease: false
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,11 +59,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id003
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: ya2yaml
+  name: rack
+  type: :runtime
+  prerelease: false
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -71,11 +73,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id004
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: gli
+  name: ya2yaml
+  type: :runtime
+  prerelease: false
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -85,11 +87,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id005
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: gli
+  type: :runtime
+  prerelease: false
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -99,11 +101,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   requirement: *id006
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rack
+  name: rake
+  type: :development
+  prerelease: false
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -113,11 +115,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   requirement: *id007
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: rspec
+  type: :development
+  prerelease: false
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -129,11 +131,11 @@ dependencies:
         - 11
         - 0
         version: 2.11.0
-  type: :development
   requirement: *id008
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: yard
+  type: :development
+  prerelease: false
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -145,11 +147,11 @@ dependencies:
         - 6
         - 7
         version: 0.6.7
-  type: :development
   requirement: *id009
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: RedCloth
+  type: :development
+  prerelease: false
   version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -161,11 +163,11 @@ dependencies:
         - 2
         - 9
         version: 4.2.9
-  type: :development
   requirement: *id010
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: aruba
+  type: :development
+  prerelease: false
   version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -177,11 +179,11 @@ dependencies:
         - 5
         - 1
         version: 0.5.1
-  type: :development
   requirement: *id011
-  prerelease: false
 - !ruby/object:Gem::Dependency 
   name: fakeweb
+  type: :development
+  prerelease: false
   version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -193,9 +195,7 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  type: :development
   requirement: *id012
-  prerelease: false
 description: Synchronizes i18n translation keys and content with localeapp.com so you don't have to manage translations by hand.
 email: 
 - chris@tigrish.com
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: localeapp
-rubygems_version: 1.8.24
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Easy i18n translation management with localeapp.com