copy_tuner_client 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f419a6b60b709e50adf9471b24b9cfa9ea9c11b
-  data.tar.gz: 3f20340aabb91929c0c62c0ebefe3669539470b9
+  metadata.gz: 065504cc3f7dfc961ad953d04a27337c74e54adb
+  data.tar.gz: bb3a4c5e3d9b3915b7564aea2a086a353069d2de
 SHA512:
-  metadata.gz: 25f0c0c8ebbf1961c4e4a94f83aca5cd8e78d2b0db12d97e0916d42ce17ad8ba3e74923e6b083cbd52bcad5afecaf4f19270c570c24dffeb0c7fd18559bbba5c
-  data.tar.gz: 589ccc3e50fbe9856334cecc6e803c59a780d570c90f518453f042da212f0a9b0ceebce61ad30eeb86be2cfc7b5e44f288cb904c51e4eaf78cf52d2df05c731e
+  metadata.gz: 60d5977669c7801caea1b016ac47546e2597c7c78e291b7c216d846f076c012676b2bfced6f965d5b2de62c1ede85c22253017ef6a26fc03f9df3c0cc150ca14
+  data.tar.gz: 9cda0e40938c1e7e5b8d69ddd7791484fa9bda4b165306d270852eaf0f0d80d25e87ba5e97829cd862ad526590b364ef77ec1d996035e5a2d85de0bd9783a74b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copy_tuner_client (0.4.11)
+    copy_tuner_client (0.4.12)
       i18n (>= 0.5.0)
       json
 

data/lib/copy_tuner_client/configuration.rb

@@ -131,6 +131,9 @@ module CopyTunerClient
     # @return [Array<Symbol>] Restrict blurb locales to upload
     attr_accessor :locales
 
+    # @return [Boolean] Html escape
+    attr_accessor :html_escape
+
     alias_method :secure?, :secure
 
     def copyray_js_injection_regexp_for_debug=(value)
@@ -158,6 +161,7 @@ module CopyTunerClient
       self.test_environments = %w(test cucumber)
       self.s3_host = 'copy-tuner-data-prod.s3.amazonaws.com'
       self.disable_copyray_comment_injection = false
+      self.html_escape = false
 
       @applied = false
     end

data/lib/copy_tuner_client/copyray.rb

@@ -6,11 +6,12 @@ module CopyTunerClient
     #   <!--COPYRAY views.home.index.message-->message
     def self.augment_template(source, key)
       augmented = if source.present?
-                    "<!--COPYRAY #{key}-->#{source}"
+                    escape = CopyTunerClient.configuration.html_escape && !source.html_safe?
+                    "<!--COPYRAY #{key}-->#{escape ? ERB::Util.html_escape(source) : source}"
                   else
                     source
                   end
-      ActiveSupport::SafeBuffer === source ? ActiveSupport::SafeBuffer.new(augmented) : augmented
+      augmented.html_safe
     end
   end
 end

data/lib/copy_tuner_client/i18n_backend.rb

@@ -28,8 +28,10 @@ module CopyTunerClient
       if CopyTunerClient.configuration.inline_translation
         content = (content.is_a?(Array) ? content : key.to_s)
       end
-      if content.respond_to?(:html_safe)
-        content.html_safe
+
+      if !CopyTunerClient.configuration.html_escape
+        # Backward compatible
+        content.respond_to?(:html_safe) ? content.html_safe : content
       else
         content
       end

data/lib/copy_tuner_client/simple_form_extention.rb

@@ -16,7 +16,7 @@ if defined?(SimpleForm)
         defaults = object.class.lookup_ancestors.map do |klass|
           "#{attributes_scope}.#{klass.model_name.i18n_key}.#{reflection_or_attribute_name}"
         end
-        CopyTunerClient::Copyray.augment_template(source, defaults.shift).html_safe
+        CopyTunerClient::Copyray.augment_template(source, defaults.shift)
       else
         source
       end

data/lib/copy_tuner_client/version.rb

@@ -1,6 +1,6 @@
 module CopyTunerClient
   # Client version
-  VERSION = '0.4.11'.freeze
+  VERSION = '0.4.12'.freeze
 
   # API version being used to communicate with the server
   API_VERSION = '2.0'.freeze

data/spec/copy_tuner_client/copyray_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'copy_tuner_client/copyray'
+
+describe CopyTunerClient::Copyray do
+  describe '.augment_template' do
+    subject { CopyTunerClient::Copyray.augment_template(source, key) }
+
+    let(:key) { 'en.test.key' }
+
+    shared_examples 'Not escaped' do
+      it { is_expected.to be_html_safe }
+      it { is_expected.to eq "<!--COPYRAY #{key}--><b>Hello</b>" }
+    end
+
+    context 'html_escape option is false' do
+      before do
+        CopyTunerClient.configure do |configuration|
+          configuration.html_escape = false
+        end
+      end
+
+      context 'string not marked as html safe' do
+        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>') }
+
+        it_behaves_like 'Not escaped'
+      end
+
+      context 'string marked as html safe' do
+        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>').html_safe }
+
+        it_behaves_like 'Not escaped'
+      end
+    end
+
+    context 'html_escape option is true' do
+      before do
+        CopyTunerClient.configure do |configuration|
+          configuration.html_escape = true
+        end
+      end
+
+      context 'string not marked as html safe' do
+        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>') }
+
+        it { is_expected.to be_html_safe }
+        it { is_expected.to eq "<!--COPYRAY #{key}-->&lt;b&gt;Hello&lt;/b&gt;" }
+      end
+
+      context 'string marked as html safe' do
+        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>').html_safe }
+
+        it_behaves_like 'Not escaped'
+      end
+    end
+  end
+end

data/spec/copy_tuner_client/i18n_backend_spec.rb

@@ -124,6 +124,20 @@ describe CopyTunerClient::I18nBackend do
       to eq('Expected')
   end
 
+  context "html_escape option is true" do
+    before do
+      CopyTunerClient.configure do |configuration|
+        configuration.html_escape = true
+      end
+    end
+
+    it "do not marks strings as html safe" do
+      cache['en.test.key'] = FakeHtmlSafeString.new("Hello")
+      backend = build_backend
+      expect(backend.translate('en', 'test.key')).not_to be_html_safe
+    end
+  end
+
   describe "with stored translations" do
     subject { build_backend }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.4.12
 platform: ruby
 authors:
 - SonicGarden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -262,6 +262,7 @@ files:
 - spec/copy_tuner_client/cache_spec.rb
 - spec/copy_tuner_client/client_spec.rb
 - spec/copy_tuner_client/configuration_spec.rb
+- spec/copy_tuner_client/copyray_spec.rb
 - spec/copy_tuner_client/i18n_backend_spec.rb
 - spec/copy_tuner_client/poller_spec.rb
 - spec/copy_tuner_client/prefixed_logger_spec.rb
@@ -319,6 +320,7 @@ test_files:
 - spec/copy_tuner_client/cache_spec.rb
 - spec/copy_tuner_client/client_spec.rb
 - spec/copy_tuner_client/configuration_spec.rb
+- spec/copy_tuner_client/copyray_spec.rb
 - spec/copy_tuner_client/i18n_backend_spec.rb
 - spec/copy_tuner_client/poller_spec.rb
 - spec/copy_tuner_client/prefixed_logger_spec.rb