copy_tuner_client 1.5.0 → 2.0.0

data/spec/copy_tuner_client/copyray_spec.rb

@@ -7,62 +7,45 @@ describe CopyTunerClient::Copyray do
 
     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
-          configuration.client = FakeClient.new
-        end
+    before do
+      CopyTunerClient.configure do |configuration|
+        configuration.project_id = 1
+        configuration.client = FakeClient.new
       end
+    end
 
-      context 'string not marked as html safe' do
-        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>') }
+    context 'when the source is html_safe (e.g. _html key)' do
+      let(:source) { FakeHtmlSafeString.new('<b>Hello</b>').html_safe }
 
-        it_behaves_like 'Not escaped'
+      it 'keeps the html_safe flag so the translation is not re-escaped' do
+        is_expected.to be_html_safe
       end
 
-      context 'string marked as html safe' do
-        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>').html_safe }
-
-        it_behaves_like 'Not escaped'
+      it 'prepends the visible marker token without escaping' do
+        is_expected.to eq '⟦CT:en.test.key⟧<b>Hello</b>'
       end
     end
 
-    context 'html_escape option is true' do
-      before do
-        CopyTunerClient.configure do |configuration|
-          configuration.html_escape = true
-          configuration.client = FakeClient.new
-        end
-      end
-
-      context 'string not marked as html safe' do
-        let(:source) { FakeHtmlSafeString.new('<b>Hello</b>') }
+    context 'when the source is plain text (not html_safe)' do
+      let(:source) { FakeHtmlSafeString.new('Hello & <World>') }
 
-        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'
+      it 'prepends the marker but keeps the source non html_safe so ActionView still escapes the body' do
+        is_expected.to eq '⟦CT:en.test.key⟧Hello & <World>'
+        is_expected.not_to be_html_safe
       end
     end
 
     context 'when the key matches local_first_key_regexp' do
-      let(:source) { 'Hello' }
       let(:key) { 'views.foo' }
 
       before { CopyTunerClient.configuration.local_first_key_regexp = /\Aviews\./ }
 
-      it 'does not inject the overlay marker' do
-        is_expected.to eq 'Hello'
+      it 'does not inject the marker into a plain source' do
+        expect(CopyTunerClient::Copyray.augment_template('Hello', key)).to eq 'Hello'
+      end
+
+      it 'does not inject the marker into an html_safe source' do
+        expect(CopyTunerClient::Copyray.augment_template('Hello'.html_safe, key)).to eq 'Hello'
       end
     end
   end

data/spec/copy_tuner_client/helper_extension_spec.rb

@@ -26,8 +26,11 @@ describe CopyTunerClient::HelperExtension do
   module KeywordArgumentsHelper
     attr_writer :controller
 
+    # NOTE: ActionView の TranslationHelper を模し、.html/_html キーのみ html_safe な訳文を返す。
+    # マーカーは平文・html_safe どちらにも注入されるが、html_safe フラグの引き継ぎを検証できるよう両方返し分ける。
     def translate(key, **options)
-      "Hello, #{options[:name]}"
+      source = "Hello, #{options[:name]}"
+      key.to_s.end_with?('.html', '_html') ? source.html_safe : source
     end
 
     def controller
@@ -54,7 +57,17 @@ describe CopyTunerClient::HelperExtension do
   end
 
   it 'works with keyword argument method' do
-    expect(view.translate('some.key', name: 'World')).to eq '<!--COPYRAY some.key-->Hello, World'
+    expect(view.translate('some.key_html', name: 'World')).to eq '⟦CT:some.key_html⟧Hello, World'
+  end
+
+  it 'injects the marker into a plain (non html_safe) translation, keeping it non html_safe' do
+    result = view.translate('some.key', name: 'World')
+    expect(result).to eq '⟦CT:some.key⟧Hello, World'
+    expect(result).not_to be_html_safe
+  end
+
+  it 'keeps the html_safe flag for an _html key so the body is not re-escaped' do
+    expect(view.translate('some.key_html', name: 'World')).to be_html_safe
   end
 
   it 'does not inject the overlay marker for a local_first key' do
@@ -62,9 +75,9 @@ describe CopyTunerClient::HelperExtension do
     expect(view.translate('views.foo', name: 'World')).to eq 'Hello, World'
   end
 
-  context 'injection guard by request format' do
-    it 'injects the marker when request.format is html' do
-      expect(view.translate('some.key', name: 'World')).to eq '<!--COPYRAY some.key-->Hello, World'
+  context 'injection guard by rendering context' do
+    it 'injects the marker when request.format is :html' do
+      expect(view.translate('some.key', name: 'World')).to eq '⟦CT:some.key⟧Hello, World'
     end
 
     %i[json text csv pdf].each do |format|

data/spec/copy_tuner_client/i18n_backend_spec.rb

@@ -138,12 +138,20 @@ describe 'CopyTunerClient::I18nBackend' do
     expect(cache['en.test.key']).to eq 'default %{interpolate}'
   end
 
+  # NOTE: backend は html_safe 化をしない（.html/_html キーの html_safe 化は ActionView の
+  # TranslationHelper が担う）。html_escape 設定の有無に関わらず素の content を返す i18n 標準準拠の挙動。
   it 'html safeを付与しないこと' do
     cache['en.test.key'] = FakeHtmlSafeString.new("Hello")
     backend = build_backend
     expect(backend.translate('en', 'test.key')).to_not be_html_safe
   end
 
+  it 'html_safe な値を渡しても backend が独自に html_safe 化しないこと' do
+    cache['en.test.key'] = FakeHtmlSafeString.new("Hello").html_safe
+    backend = build_backend
+    expect(backend.translate('en', 'test.key')).to be_html_safe
+  end
+
   it 'defaultが配列の場合に順に検索できること' do
     cache['en.key.one'] = "Expected"
     backend = build_backend
@@ -151,21 +159,6 @@ describe 'CopyTunerClient::I18nBackend' do
       to eq('Expected')
   end
 
-  context 'html_escapeオプションがtrueの場合' do
-    before do
-      CopyTunerClient.configure do |configuration|
-        configuration.html_escape = true
-        configuration.client = FakeClient.new
-      end
-    end
-
-    it '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
-
   context '非文字列キーの場合' do
     it 'キャッシュに登録されないこと' do
       expect { subject.translate('en', {}) }.to throw_symbol(:exception)

data/spec/support/client_spec_helpers.rb

@@ -4,7 +4,6 @@ module ClientSpecHelpers
     CopyTunerClient.configure(false) do |config|
       config.api_key = 'abc123'
       config.s3_host = 'copy-tuner.com'
-      config.html_escape = true
     end
   end
 end

data/src/copyray.css

@@ -79,10 +79,12 @@
 
 .copyray-specimen-handle {
   float: left;
+  margin: 0 2px 2px 0;
   background: #fff;
   padding: 0 3px;
   color: #333;
   font-size: 10px;
+  cursor: pointer;
 }
 
 .copyray-specimen-handle.Specimen {
@@ -187,6 +189,15 @@ a.copyray-toggle-button:hover {
   background-color: #555;
 }
 
+.copy-tuner-bar__notice {
+  display: inline-block;
+  margin: 8px;
+  font-size: 13px;
+  line-height: 24px;
+  vertical-align: middle;
+  color: #ffd24d;
+}
+
 input[type='text'].copy-tuner-bar__search {
   -webkit-appearance: none;
   -moz-appearance: none;

data/src/copyray.ts

@@ -1,35 +1,16 @@
 import CopyTunerBar from './copytuner_bar'
 import Specimen from './specimen'
 
-const findBlurbs = () => {
-  const filterNone = () => NodeFilter.FILTER_ACCEPT
-
-  // @ts-expect-error TS2554
-  const iterator = document.createNodeIterator(document.body, NodeFilter.SHOW_COMMENT, filterNone, false)
-
-  const comments = []
-  let curNode
-
-  while ((curNode = iterator.nextNode())) {
-    comments.push(curNode)
-  }
-
-  return (
-    comments
-      // @ts-expect-error TS2531
-      .filter((comment) => comment.nodeValue.startsWith('COPYRAY'))
-      .map((comment) => {
-        // @ts-expect-error TS2488
-        const [, key] = comment.nodeValue.match(/^COPYRAY (\S*)$/)
-        const element = comment.parentNode
-        return { key, element }
-      })
-  )
-}
+const findBlurbs = () =>
+  Array.from(document.querySelectorAll('[data-copyray-key]')).map((element) => ({
+    // 1 要素に複数キーがカンマ区切りで入りうる（同一テキストノードに複数訳文が連結された場合）
+    keys: (element.getAttribute('data-copyray-key') ?? '').split(',').filter(Boolean),
+    element,
+  }))
 
 export default class Copyray {
   // @ts-expect-error TS7006
-  constructor(baseUrl, data) {
+  constructor(baseUrl, data, keysSkipped = false) {
     // @ts-expect-error TS2339
     this.baseUrl = baseUrl
     // @ts-expect-error TS2339
@@ -46,7 +27,7 @@ export default class Copyray {
     this.boundOpen = this.open.bind(this)
 
     // @ts-expect-error TS2339
-    this.copyTunerBar = new CopyTunerBar(document.querySelector('#copy-tuner-bar'), this.data, this.boundOpen)
+    this.copyTunerBar = new CopyTunerBar(document.querySelector('#copy-tuner-bar'), this.data, this.boundOpen, keysSkipped)
   }
 
   show() {
@@ -93,9 +74,9 @@ export default class Copyray {
   }
 
   makeSpecimens() {
-    for (const { element, key } of findBlurbs()) {
+    for (const { element, keys } of findBlurbs()) {
       // @ts-expect-error TS2339
-      this.specimens.push(new Specimen(element, key, this.boundOpen))
+      this.specimens.push(new Specimen(element, keys, this.boundOpen))
     }
   }
 

data/src/copytuner_bar.ts

@@ -5,7 +5,7 @@ const HIDDEN_CLASS = 'copy-tuner-hidden'
 
 export default class CopytunerBar {
   // @ts-expect-error TS7006
-  constructor(element, data, callback) {
+  constructor(element, data, callback, keysSkipped = false) {
     // @ts-expect-error TS2339
     this.element = element
     // @ts-expect-error TS2339
@@ -19,9 +19,23 @@ export default class CopytunerBar {
     // @ts-expect-error TS2339
     this.element.append(this.logMenuElement)
 
+    // 巨大DOM/Nokogiri例外でキー付与がスキップされた場合は、オーバーレイが使えないので
+    // ツールバー（Translations in this page）から編集する旨を案内する。
+    if (keysSkipped) {
+      this.appendSkippedNotice()
+    }
+
     this.addHandler()
   }
 
+  appendSkippedNotice() {
+    const notice = document.createElement('span')
+    notice.classList.add('copy-tuner-bar__notice')
+    notice.textContent = '⚠ This page is too large for the overlay. Use "Translations in this page" to edit.'
+    // @ts-expect-error TS2339
+    this.element.append(notice)
+  }
+
   addHandler() {
     // @ts-expect-error TS2339
     const openLogButton = this.element.querySelector('.js-copy-tuner-bar-open-log')

data/src/main.ts

@@ -9,6 +9,9 @@ declare global {
       toggle?: () => void
       // TODO: type
       data: object
+      // 巨大DOM/Nokogiri例外で data-copyray-key 付与をスキップしたか。
+      // true のときオーバーレイは使えないのでツールバーから編集する旨を案内する。
+      keysSkipped?: boolean
     }
   }
 }
@@ -30,10 +33,10 @@ const appendCopyTunerBar = (url: string) => {
 }
 
 const start = () => {
-  const { url, data } = window.CopyTuner
+  const { url, data, keysSkipped } = window.CopyTuner
 
   appendCopyTunerBar(url)
-  const copyray = new Copyray(url, data)
+  const copyray = new Copyray(url, data, Boolean(keysSkipped))
   window.CopyTuner.toggle = () => copyray.toggle()
 
   document.addEventListener('keydown', (event) => {

data/src/specimen.ts

@@ -4,11 +4,11 @@ const ZINDEX = 2_000_000_000
 
 export default class Specimen {
   // @ts-expect-error TS7006
-  constructor(element, key, callback) {
+  constructor(element, keys, callback) {
     // @ts-expect-error TS2339
     this.element = element
     // @ts-expect-error TS2339
-    this.key = key
+    this.keys = keys
     // @ts-expect-error TS2339
     this.callback = callback
   }
@@ -19,10 +19,11 @@ export default class Specimen {
     // @ts-expect-error TS2339
     if (this.box === null) return
 
+    // box 全体のクリックは先頭キーを開く（広いクリック領域を維持）。複数キー時は各ラベルから個別に開ける
     // @ts-expect-error TS2339
     this.box.addEventListener('click', () => {
       // @ts-expect-error TS2339
-      this.callback(this.key)
+      this.callback(this.keys[0])
     })
 
     // @ts-expect-error TS2339
@@ -69,16 +70,25 @@ export default class Specimen {
       this.box.style.left = `${left}px`
     }
 
-    box.append(this.makeLabel())
+    // @ts-expect-error TS2339
+    for (const key of this.keys) {
+      box.append(this.makeLabel(key))
+    }
     return box
   }
 
-  makeLabel() {
+  // @ts-expect-error TS7006
+  makeLabel(key) {
     const div = document.createElement('div')
     div.classList.add('copyray-specimen-handle')
     div.classList.add('Specimen')
-    // @ts-expect-error TS2339
-    div.textContent = this.key
+    div.textContent = key
+    // ラベルのクリックはそのキーを開く。box への伝播を止めて先頭キーとの二重発火を防ぐ
+    div.addEventListener('click', (event) => {
+      event.stopPropagation()
+      // @ts-expect-error TS2339
+      this.callback(key)
+    })
     return div
   }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - SonicGarden
@@ -198,6 +198,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - app/assets/javascripts/copytuner.js
 - app/assets/stylesheets/copytuner.css
 - copy_tuner_client.gemspec
@@ -210,6 +211,8 @@ files:
 - lib/copy_tuner_client/client.rb
 - lib/copy_tuner_client/configuration.rb
 - lib/copy_tuner_client/copyray.rb
+- lib/copy_tuner_client/copyray/marker.rb
+- lib/copy_tuner_client/copyray/rewriter.rb
 - lib/copy_tuner_client/copyray_middleware.rb
 - lib/copy_tuner_client/dotted_hash.rb
 - lib/copy_tuner_client/engine.rb
@@ -237,10 +240,15 @@ files:
 - skills/copy-tuner-to-locales-migrate-prefix/references/local-first-regexp.md
 - skills/copy-tuner-to-locales-migrate-prefix/references/verification-per-prefix.md
 - skills/copy-tuner-to-locales-migrate-prefix/scripts/migrate_prefix.rb
+- skills/copy-tuner-to-t-migrate/SKILL.md
+- skills/copy-tuner-to-t-migrate/scripts/migrate_tt.rb
 - skills/copy-tuner/SKILL.md
 - 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/marker_spec.rb
+- spec/copy_tuner_client/copyray/rewriter_spec.rb
+- spec/copy_tuner_client/copyray_middleware_spec.rb
 - spec/copy_tuner_client/copyray_spec.rb
 - spec/copy_tuner_client/dotted_hash_spec.rb
 - spec/copy_tuner_client/helper_extension_spec.rb