copy_tuner_client 0.7.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d873dcd3c1fc5d4319ea4185a8da8bc575709fd7622676e1a25d877a21ed9f5
-  data.tar.gz: 217af205a8c76d202ed91a84ad34021d6cc2b42191f13a41dcd4421df6b3e2ed
+  metadata.gz: bccd14def1ebe5752df2720935cff2474e749adc498cdcd310e4c8eeb3144245
+  data.tar.gz: f1acb0047c41797eb773eb852379d1921e040a1e5688eea89a7becce3f4540c4
 SHA512:
-  metadata.gz: 135e569c847621296af1e7d03db22a68631fb1ef928b61547c915f9ec94734647659b3b8a6bc26c6a120b93713e48939da3832697fb35a8cb207fb346c7831bf
-  data.tar.gz: c56ad0f710be1a534cbdc1966277679c005abd43ed82b28d5b31205e1376a6b99c2b1e86186e04273c6c1df79fbad1cb2ca7141d4c8547ec5e9bc713f3213f26
+  metadata.gz: 669c8e6bc71974318d16f4277f498a8933869486a23a9fcbbd67375cfd9d8325e65a700645b01454d062d986763a32a264f33d3b01f2ec41cc7e4d5d5fe7035d
+  data.tar.gz: b201841f91363ec9f725bd071f2ddb8f341412ba0ce58edcd9e39b530ff092356592d33a57366fed95070d64e0226b428144b4fc315ffc6b121ac062f6d2848f

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.10.0
+
+- Add copy_tuner:detect_html_incompatible_keys task
+
+## 0.9.0
+
+- Do not upload invalid type keys
+
+## 0.8.1
+
+- Fix bug in `CopyrayMiddleware`
+
+## 0.8.0
+
+- Change the default value of config.upload_disabled_environments
+
 ## 0.7.0
 
 - Add config.upload_disabled_environments

data/Gemfile.lock

@@ -14,9 +14,10 @@ GIT
 PATH
   remote: .
   specs:
-    copy_tuner_client (0.7.0)
+    copy_tuner_client (0.10.0)
       i18n (>= 0.5.0)
       json
+      nokogiri
 
 GEM
   remote: http://rubygems.org/

data/copy_tuner_client.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.5.0'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'json'
+  s.add_dependency 'nokogiri'
   s.add_development_dependency 'rails', '~> 5.2.4.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '3.8.0' # NOTE: 3.9.0だとundefined method `synchronize'でコケるテストがある

data/lib/copy_tuner_client/configuration.rb

@@ -148,7 +148,7 @@ module CopyTunerClient
       self.sync_interval_staging = 0
       self.secure = true
       self.test_environments = %w(test cucumber)
-      self.upload_disabled_environments = []
+      self.upload_disabled_environments = %w[production staging]
       self.s3_host = 'copy-tuner-data-prod.s3.amazonaws.com'
       self.disable_copyray_comment_injection = false
       self.html_escape = false

data/lib/copy_tuner_client/copyray_middleware.rb

@@ -37,14 +37,14 @@ module CopyTunerClient
       if CopyTunerClient::TranslationLog.initialized?
         json = CopyTunerClient::TranslationLog.translations.to_json
         # Use block to avoid back reference \?
-        html.sub('</body>') { "<div id='copy-tuner-data' data-copy-tuner-translation-log='#{ERB::Util.html_escape json}' data-copy-tuner-url='#{CopyTunerClient.configuration.project_url}'></div></body>" }
+        append_to_html_body(html, "<div id='copy-tuner-data' data-copy-tuner-translation-log='#{ERB::Util.html_escape json}' data-copy-tuner-url='#{CopyTunerClient.configuration.project_url}'></div>")
       else
         html
       end
     end
 
     def inject_copy_tuner_bar(html)
-      html.sub(/<body[^>]*>/) { "#{Regexp.last_match}\n#{render_copy_tuner_bar}" }
+      append_to_html_body(html, render_copy_tuner_bar)
     end
 
     def render_copy_tuner_bar
@@ -59,19 +59,25 @@ module CopyTunerClient
     end
 
     def append_css(html)
-      html.sub(/<body[^>]*>/) { "#{Regexp.last_match}\n#{css_tag}" }
+      append_to_html_body(html, css_tag)
     end
 
     def append_js(html)
-      html.sub(%r{</body>}) do
-       "#{helpers.javascript_include_tag(:copyray)}\n#{Regexp.last_match}"
-      end
+      append_to_html_body(html, helpers.javascript_include_tag(:copyray))
     end
 
     def css_tag
       helpers.stylesheet_link_tag :copyray, media: :all
     end
 
+    def append_to_html_body(html, content)
+      content = content.html_safe if content.respond_to?(:html_safe)
+      return html unless html.include?('</body>')
+
+      position = html.rindex('</body>')
+      html.insert(position, content + "\n")
+    end
+
     def file?(headers)
       headers["Content-Transfer-Encoding"] == "binary"
     end

data/lib/copy_tuner_client/i18n_backend.rb

@@ -61,6 +61,8 @@ module CopyTunerClient
     private
 
     def lookup(locale, key, scope = [], options = {})
+      return nil if !key.is_a?(String) && !key.is_a?(Symbol)
+
       parts = I18n.normalize_keys(locale, key, scope, options[:separator])
       key_with_locale = parts.join('.')
       content = cache[key_with_locale] || super
@@ -86,6 +88,8 @@ module CopyTunerClient
 
     def default(locale, object, subject, options = {})
       content = super(locale, object, subject, options)
+      return content if !object.is_a?(String) && !object.is_a?(Symbol)
+
       if content.respond_to?(:to_str)
         parts = I18n.normalize_keys(locale, object, options[:scope], options[:separator])
         # NOTE: ActionView::Helpers::TranslationHelper#translate wraps default String in an Array

data/lib/copy_tuner_client/i18n_compat.rb

@@ -0,0 +1,14 @@
+require 'nokogiri'
+
+module CopyTunerClient
+  module I18nCompat
+    def select_html_incompatible_blurbs(blurbs)
+      non_html_key_blurbs = blurbs.reject { |key| key.ends_with?('.html') || key.ends_with?('_html') }
+      html_blurbs = non_html_key_blurbs.select do |key, content|
+        Nokogiri::HTML.fragment(content).children.any? { |node| node.name != 'text' }
+      end
+    end
+
+    module_function :select_html_incompatible_blurbs
+  end
+end

data/lib/copy_tuner_client/translation_log.rb

@@ -19,7 +19,7 @@ module CopyTunerClient
     def self.install_hook
       I18n.class_eval do
         class << self
-          def translate_with_copy_tuner_hook(key, **options)
+          def translate_with_copy_tuner_hook(key = nil, **options)
             scope = options[:scope]
             scope = scope.dup if scope.is_a?(Array) || scope.is_a?(String)
             result = translate_without_copy_tuner_hook(key, **options)

data/lib/copy_tuner_client/version.rb

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

data/lib/tasks/copy_tuner_client_tasks.rake

@@ -25,8 +25,21 @@ namespace :copy_tuner do
     if conflict_keys.empty?
       puts 'All success'
     else
-      pp conflict_keys
-      raise 'Exists invalid keys'
+      puts conflict_keys.sort.join("\n")
+      exit 1
+    end
+  end
+
+  desc "Detect html incompatible keys."
+  task :detect_html_incompatible_keys => :environment do
+    require 'copy_tuner_client/i18n_compat'
+    html_incompatible_blurbs = CopyTunerClient::I18nCompat.select_html_incompatible_blurbs(CopyTunerClient.cache.blurbs)
+
+    if html_incompatible_blurbs.empty?
+      puts 'All success'
+    else
+      puts html_incompatible_blurbs.keys.sort.join("\n")
+      exit 1
     end
   end
 end

data/spec/copy_tuner_client/i18n_backend_spec.rb

@@ -139,6 +139,13 @@ describe CopyTunerClient::I18nBackend do
     end
   end
 
+  context 'non-string key' do
+    it 'Not to be registered in the cache' do
+      expect { subject.translate('en', {}) }.to throw_symbol(:exception)
+      expect(cache).not_to have_key 'en.{}'
+    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.7.0
+  version: 0.10.0
 platform: ruby
 authors:
 - SonicGarden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,7 @@ files:
 - lib/copy_tuner_client/engine.rb
 - lib/copy_tuner_client/errors.rb
 - lib/copy_tuner_client/i18n_backend.rb
+- lib/copy_tuner_client/i18n_compat.rb
 - lib/copy_tuner_client/poller.rb
 - lib/copy_tuner_client/prefixed_logger.rb
 - lib/copy_tuner_client/process_guard.rb