localeapp 0.8.0 → 0.8.1

data/CHANGELOG.md

@@ -1,11 +1,16 @@
 # master
 
+# Version 0.8.1
+
+* Add the `blacklisted_keys_pattern` configuration option
+* Prevent blacklisted keys from being sent to Locale servers in the Rails exception handler
+
 # Version 0.8.0
 
 * Fix problem with line ending in three dots. (@holli)
 * Change deprecated File.exists? to File.exist?
-* Fix "install --github" so it append README.md, before it truncated the README.md file with new content, now its
-append content in a more proper manner. Also fix .gitignore injection so it ensure newline.
+* Fix "install --github" so it appends README.md. Before it truncated the README.md file with new content, now it appends content in a more correct manner.
+* Fix .gitignore injection so it ensures a newline.
 * Extract synchronisation data into SyncFile and SyncData classes. These value objects allow us to read synchronisation data from yaml files that have both strings and symbols as keys. Sync files now use strings as keys when serialising to yaml. If you find that you have a log/localeapp.yml file that contains the string !ruby, run localeapp pull to update to "regular" yaml syntax.
 * Tweak Aruba config for jRuby (development related only).
 * Fix minor typo in "updater" output message.

data/README.md

@@ -124,6 +124,14 @@ Automatic reloading is only enabled in the development environment by default an
 
     config.reloading_environments = []
 
+### Blacklisting keys and namespaces (Rails only)
+
+To prevent certain missing translations from being sent to the Locale servers - in case of automatically generated keys from a gem for example - you can configure the `blacklisted_keys_pattern` option with a regular expression.
+
+For example, to prevent all keys containing the word "simple_form" :
+
+    config.blacklisted_keys_pattern = /simple_form/
+
 ### Caching
 
 To prevent localeapp from sending translations every time they are missing, add this config setting:

data/lib/localeapp/configuration.rb

@@ -77,6 +77,12 @@ module Localeapp
     # Enable or disable the missing translation cache
     # default: false
     attr_accessor :cache_missing_translations
+    
+    # A regular expression that is matched against a translation key.
+    # If the key matches, the translation will not be sent to the Locale
+    # server via the rails exception handler.
+    # default: nil
+    attr_accessor :blacklisted_keys_pattern
 
     def initialize
       defaults.each do |setting, value|

data/lib/localeapp/missing_translations.rb

@@ -1,5 +1,13 @@
 module Localeapp
-  MissingTranslationRecord = Struct.new(:key, :locale, :description, :options)
+  MissingTranslationRecord = Struct.new(:key, :locale, :description, :options) do
+    def blacklisted?
+      key_path.match(Localeapp.configuration.blacklisted_keys_pattern)
+    end
+
+    def key_path
+      [options[:scope], key].compact.join('.')
+    end
+  end
 
   class MissingTranslations
     @cached_keys = []
@@ -39,6 +47,13 @@ module Localeapp
       data
     end
 
+    def reject_blacklisted
+      return unless Localeapp.configuration.blacklisted_keys_pattern
+      @translations.each do |locale, records|
+        records.reject! { |key, record| record.blacklisted? }
+      end
+    end
+
     private
 
     def cached_keys

data/lib/localeapp/rails/controller.rb

@@ -27,7 +27,7 @@ module Localeapp
 
       def send_missing_translations
         return if ::Localeapp.configuration.sending_disabled?
-
+        ::Localeapp.missing_translations.reject_blacklisted
         ::Localeapp.sender.post_missing_translations
       end
     end

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/spec/localeapp/configuration_spec.rb

@@ -85,6 +85,10 @@ describe Localeapp::Configuration do
     expect { configuration.daemon_log_file = 'log/la.log' }.to change(configuration, :daemon_log_file).to('log/la.log')
   end
 
+  it "sets the sending_blacklist by default" do
+    expect(configuration.blacklisted_keys_pattern).to be_nil
+  end
+
   context "enabled_sending_environments" do
     it "is only development by default" do
       configuration.sending_environments.should == ['development']

data/spec/localeapp/missing_translations_spec.rb

@@ -61,3 +61,41 @@ describe Localeapp::MissingTranslations, "#to_send" do
     end
   end
 end
+
+describe Localeapp::MissingTranslations, "#reject_blacklisted" do
+  let(:translations) { Localeapp::MissingTranslations.new }
+  let(:count) { Proc.new { translations.to_send.count } }
+
+  before do
+    translations.add(:en, 'feline.lion')
+    translations.add(:en, 'feline.tiger')
+    translations.add(:en, 'bird.eagle')
+    translations.add(:de, 'crow', nil, {:scope => 'bird'})
+    translations.add(:fr, 'feline.lion')
+    translations.add(:fr, 'reptile.lizard')
+  end
+
+  it "removes translations whose key matches the blacklisted_keys_pattern" do
+    with_configuration(:blacklisted_keys_pattern => /^feline/) do
+      expect { translations.reject_blacklisted }.to change(count, :call).by(-3)
+    end
+  end
+
+  it "removes translations whose scope matches the blacklisted_keys_pattern" do
+    with_configuration(:blacklisted_keys_pattern => /^bird\./) do
+      expect { translations.reject_blacklisted }.to change(count, :call).by(-2)
+    end
+  end
+
+  it "does nothing when blacklisted_keys_pattern is nil" do
+    with_configuration do
+      expect { translations.reject_blacklisted }.to_not change(count, :call)
+    end
+  end
+
+  it "does nothing when blacklisted_keys_pattern does not match anything" do
+    with_configuration(:blacklisted_keys_pattern => /^canine/) do
+      expect { translations.reject_blacklisted }.to_not change(count, :call)
+    end
+  end
+end

data/spec/localeapp/rails/controller_spec.rb

@@ -136,4 +136,10 @@ describe Localeapp::Rails::Controller, '#send_missing_translations' do
     Localeapp.sender.should_receive(:post_missing_translations)
     @controller.send_missing_translations
   end
+
+  it "rejects blacklisted translations" do
+    Localeapp.configuration.environment_name = 'development'
+    Localeapp.missing_translations.should_receive(:reject_blacklisted)
+    @controller.send_missing_translations
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localeapp
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449874240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449874240
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449873440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449873440
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449872140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,15 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449872140
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449892660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,15 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449892660
 - !ruby/object:Gem::Dependency
   name: ya2yaml
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449891000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -86,15 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449891000
 - !ruby/object:Gem::Dependency
   name: gli
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449889260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -102,15 +77,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449889260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449888160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -118,15 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449888160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449887060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -134,15 +99,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
+  version_requirements: *70249449887060
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449966160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -150,15 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449966160
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449961880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,15 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449961880
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449959460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -182,15 +132,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449959460
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249449995660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -198,12 +143,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249449995660
 description: Synchronizes i18n translation keys and content with localeapp.com so
   you don't have to manage translations by hand.
 email:
@@ -320,7 +260,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1045409387889628647
+      hash: -1665845517778258458
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -329,10 +269,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1045409387889628647
+      hash: -1665845517778258458
 requirements: []
 rubyforge_project: localeapp
-rubygems_version: 1.8.23.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Easy i18n translation management with localeapp.com