copy_tuner_client 2.1.1 → 2.2.0

data/lib/copy_tuner_client/rails.rb

@@ -4,15 +4,16 @@ module CopyTunerClient
     # Sets up the logger, environment, name, project root, and framework name
     # for Rails applications. Must be called after framework initialization.
     def self.initialize
-      CopyTunerClient.configure(false) do |config|
+      CopyTunerClient.configure(apply: false) do |config|
         config.environment_name = ::Rails.env
-        config.logger           = if defined?(::Rails::Console)
-          Logger.new('/dev/null')
-        elsif defined?(::Rails) && ::Rails.env.development?
-          Logger.new('log/copy_tuner.log')
-        else
-          ::Rails.logger
-        end
+        config.logger           =
+          if defined?(::Rails::Console)
+            Logger.new(File::NULL)
+          elsif defined?(::Rails) && ::Rails.env.development?
+            Logger.new('log/copy_tuner.log')
+          else
+            ::Rails.logger
+          end
         config.framework = "Rails: #{::Rails::VERSION::STRING}"
         config.middleware = ::Rails.configuration.middleware
         config.download_cache_dir = ::Rails.root.join('tmp', 'cache', 'copy_tuner_client')

data/lib/copy_tuner_client/request_sync.rb

@@ -8,8 +8,8 @@ module CopyTunerClient
   # Rack middleware that synchronizes with CopyTuner during each request.
   #
   # This is injected into the Rails middleware stack in development environments.
-  class RequestSync
-    VIEW_PATH = File.expand_path('../../../ui/views/', __FILE__)
+  class RequestSync # rubocop:disable Metrics/ClassLength
+    VIEW_PATH = File.expand_path('../../ui/views', __dir__)
 
     # @param app [Rack] the upstream app into whose responses to inject the editor
     # @param options [Hash]
@@ -29,7 +29,7 @@ module CopyTunerClient
     # Invokes the upstream Rack application and flushes the cache after each
     # request.
     def call(env)
-      if /^\/copytuner/ =~ ::Rack::Request.new(env).path_info
+      if %r{^/copytuner} =~ ::Rack::Request.new(env).path_info
         dup._call(env)
       else
         first_request = @first
@@ -53,7 +53,7 @@ module CopyTunerClient
       @req = ::Rack::Request.new(env)
 
       case @req.path_info
-      when /^\/copytuner\/?$/
+      when %r{^/copytuner/?$}
         index
       when /sync/
         sync
@@ -71,21 +71,19 @@ module CopyTunerClient
 
     def sync
       @cache.sync
-      ::Rack::Response.new{|r| r.redirect('/copytuner/')}.finish
+      ::Rack::Response.new { |r| r.redirect('/copytuner/') }.finish
     end
 
-    def render(view, layout=true)
+    def render(view, layout: true) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       add_rack_array = true
-      if view.is_a? Hash
+      if view.is_a?(Hash)
         layout = false
-        if view[:object]
-          object = view[:object]
-        end
+        object = view[:object] if view[:object]
 
         if view[:collection]
-          return view[:collection].map do |object|
-            render({:partial => view[:partial], :object => object})
-          end.join(' ')
+          return view[:collection].map { |object|
+            render({ partial: view[:partial], object: })
+          }.join(' ')
         end
 
         if view[:partial]
@@ -93,17 +91,19 @@ module CopyTunerClient
           view = "_#{view[:partial]}"
         end
       end
-      binding = Proc.new {}.binding
-      if layout
-        body = render_with_layout(view) do
+      binding = proc {}.binding
+      body =
+        if layout
+          render_with_layout(view) do
+            render_without_layout(view, binding)
+          end
+        else
           render_without_layout(view, binding)
         end
-      else
-        body = render_without_layout(view, binding)
-      end
       if add_rack_array
         ::Rack::Response.new(
-          body, 200,
+          body,
+          200,
           ::Rack::CONTENT_TYPE => 'text/html; charset=utf-8'
         ).finish
       else
@@ -115,13 +115,14 @@ module CopyTunerClient
     # that block are interpolated into the layout
     def render_with_layout(view)
       body = ERB.new(File.read(File.join(VIEW_PATH, 'layouts/copytuner_default.html.erb')))
-      body.result(Proc.new {}.binding)
+      body.result(proc {}.binding)
     end
 
     # you have to pass a binding to this (a proc) so that ERB can have
     # access to helper functions and local variables
     def render_without_layout(view, binding)
-      ERB.new(File.read(File.join(VIEW_PATH, 'copytuner', view.to_s + '.html.erb')), eoutvar: 'frobnitz').result(binding)
+      path = File.join(VIEW_PATH, 'copytuner', "#{view}.html.erb")
+      ERB.new(File.read(path), eoutvar: 'frobnitz').result(binding)
     end
 
     def cancel_sync?(env)
@@ -133,17 +134,18 @@ module CopyTunerClient
     end
 
     def asset_request?(env)
-      env['PATH_INFO'] =~ /^\/assets/
+      env['PATH_INFO'] =~ %r{^/assets}
     end
 
     def in_interval?
       return false if @last_synced.nil?
       return false if @interval <= 0
+
       next_sync_at > Time.now.utc
     end
 
     def next_sync_at
-      @last_synced + @interval if @last_synced and @interval
+      @last_synced + @interval if @last_synced && @interval
     end
 
     def update_last_synced

data/lib/copy_tuner_client/simple_form_extention.rb

@@ -1,29 +1,33 @@
 require 'copy_tuner_client/copyray'
 
 begin
-  require "simple_form"
+  require 'simple_form'
 rescue LoadError
+  # simple_form は任意依存のため、未導入環境では以降の拡張定義自体をスキップする
 end
 
 if defined?(SimpleForm)
+  # SimpleForm のラベル生成に Copyray のオーバーレイマーカーを注入する
   module SimpleForm::Components::Labels
     protected
+
     def label_translation_with_copyray_comment
       source = label_translation_without_copyray_comment
 
       if !CopyTunerClient.configuration.disable_copyray_comment_injection && object.class.respond_to?(:lookup_ancestors)
         attributes_scope = "#{object.class.i18n_scope}.attributes"
-        defaults = object.class.lookup_ancestors.map do |klass|
-          "#{attributes_scope}.#{klass.model_name.i18n_key}.#{reflection_or_attribute_name}"
-        end
+        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)
       else
         source
       end
     end
     if CopyTunerClient.configuration.enable_middleware?
-      alias_method :label_translation_without_copyray_comment, :label_translation
-      alias_method :label_translation, :label_translation_with_copyray_comment
+      alias label_translation_without_copyray_comment label_translation
+      alias label_translation label_translation_with_copyray_comment
     end
   end
 end

data/lib/copy_tuner_client/translation_log.rb

@@ -1,4 +1,5 @@
 module CopyTunerClient
+  # リクエスト中に翻訳されたキーと結果をスレッドローカルに記録する（Copyray オーバーレイの JSON 出力に使う）
   class TranslationLog
     def self.translations
       Thread.current[:translations]
@@ -23,16 +24,19 @@ module CopyTunerClient
 
     def self.install_hook
       I18n.class_eval do
+        # alias_method が参照するため、alias_method 群より先に定義する必要がある
+        # rubocop:disable Style/ClassMethodsDefinitions
         class << self
           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)
 
-            if key.is_a?(Array)
-              key.zip(result).each { |k, v| CopyTunerClient::TranslationLog.add(I18n.normalize_keys(nil, k, scope).compact.join('.'), v) unless v.is_a?(Array) }
-            else
-              CopyTunerClient::TranslationLog.add(I18n.normalize_keys(nil, key, scope).compact.join('.'), result) unless result.is_a?(Array)
+            pairs = key.is_a?(Array) ? key.zip(result) : [[key, result]]
+            pairs.each do |k, v|
+              next if v.is_a?(Array)
+
+              CopyTunerClient::TranslationLog.add(I18n.normalize_keys(nil, k, scope).compact.join('.'), v)
             end
             result
           end
@@ -40,9 +44,10 @@ module CopyTunerClient
           if CopyTunerClient.configuration.enable_middleware?
             alias_method :translate_without_copy_tuner_hook, :translate
             alias_method :translate, :translate_with_copy_tuner_hook
-            alias :t :translate
+            alias_method :t, :translate
           end
         end
+        # rubocop:enable Style/ClassMethodsDefinitions
       end
     end
   end

data/lib/copy_tuner_client/version.rb

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

data/lib/copy_tuner_client.rb

@@ -55,16 +55,12 @@ module CopyTunerClient
   # @param apply [Boolean] (internal) whether the configuration should be applied yet.
   #
   # @yield [Configuration] the configuration to be modified
-  def self.configure(apply = true)
+  def self.configure(apply: true)
     self.configuration ||= Configuration.new
-    yield configuration
+    yield(configuration)
 
-    if apply
-      configuration.apply
-    end
+    configuration.apply if apply
   end
 end
 
-if defined? ::Rails
-  require 'copy_tuner_client/rails'
-end
+require 'copy_tuner_client/rails' if defined? Rails

data/lib/tasks/copy_tuner_client_tasks.rake

@@ -1,25 +1,23 @@
-namespace :copy_tuner do
-  desc "Notify CopyTuner of a new deploy."
-  task :deploy => :environment do
+namespace :copy_tuner do # rubocop:disable Metrics/BlockLength
+  desc 'Notify CopyTuner of a new deploy.'
+  task deploy: :environment do
     CopyTunerClient.deploy
-    puts "Successfully marked all blurbs as published."
+    puts 'Successfully marked all blurbs as published.'
   end
 
-  desc "Export CopyTuner blurbs to yaml."
+  desc 'Export CopyTuner blurbs to yaml.'
   task :export, %i[path] => :environment do |_, args|
-    args.with_defaults(path: "config/locales/copy_tuner.yml")
+    args.with_defaults(path: 'config/locales/copy_tuner.yml')
     CopyTunerClient.cache.sync
 
-    if yml = CopyTunerClient.export
-      File.new("#{Rails.root}/#{args[:path]}", 'w').write(yml)
-      puts "Successfully exported blurbs to #{args[:path]}."
-    else
-      raise "No blurbs have been cached."
-    end
+    yml = CopyTunerClient.export or raise 'No blurbs have been cached.'
+
+    File.new("#{Rails.root}/#{args[:path]}", 'w').write(yml)
+    puts "Successfully exported blurbs to #{args[:path]}."
   end
 
-  desc "Detect invalid keys."
-  task :detect_conflict_keys => :environment do
+  desc 'Detect invalid keys.'
+  task detect_conflict_keys: :environment do
     conflict_keys = CopyTunerClient::DottedHash.conflict_keys(CopyTunerClient.cache.blurbs)
 
     if conflict_keys.empty?
@@ -30,8 +28,8 @@ namespace :copy_tuner do
     end
   end
 
-  desc "Detect html incompatible keys."
-  task :detect_html_incompatible_keys => :environment do
+  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)
 

data/skills/copy-tuner-to-locales-migrate-prefix/scripts/migrate_prefix.rb

@@ -40,12 +40,16 @@ end
 options = {}
 parser =
   OptionParser.new do |opts|
-    opts.banner = 'Usage: bin/rails runner migrate_prefix.rb -- --prefix PREFIX --export PATH --out PATH [--regexp PATTERN] [--originals-glob GLOB]'
+    opts.banner =
+      'Usage: bin/rails runner migrate_prefix.rb -- --prefix PREFIX --export PATH --out PATH ' \
+      '[--regexp PATTERN] [--originals-glob GLOB]'
     opts.on('--prefix PREFIX', 'ドット区切りの対象 prefix（例: date / activerecord.attributes）') { |v| options[:prefix] = v }
     opts.on('--export PATH', '全件 export YAML（手順3で出力）') { |v| options[:export] = v }
     opts.on('--out PATH', '移行分の出力先（例: config/locales/0010_date.yml）') { |v| options[:out] = v }
     opts.on('--regexp PATTERN', 'leaf キー検証用の正規表現（省略時は prefix から \A<prefix>\. を生成）') { |v| options[:regexp] = v }
-    opts.on('--originals-glob GLOB', 'オリジナルファイルの glob（既定: config/locales/0000_original_*.yml）') { |v| options[:originals_glob] = v }
+    opts.on('--originals-glob GLOB', 'オリジナルファイルの glob（既定: config/locales/0000_original_*.yml）') do |v|
+      options[:originals_glob] = v
+    end
     opts.on('--locales LIST', 'カンマ区切りの対象 locale（既定: I18n.available_locales。検証用の上書き）') { |v| options[:locales] = v }
   end
 # `bin/rails runner script -- ...` の `--` 以降だけを渡したいが、runner が剥がさない環境もあるため両対応。
@@ -186,9 +190,7 @@ LOCALES.each do |locale|
 end
 
 # 全 locale でスキップ＝当該 prefix がどこにも存在しない（prefix の typo）。
-if merged_by_locale.empty?
-  die("prefix '#{PREFIX}' のキーが export にもオリジナルにも見つからない。prefix を確認すること。")
-end
+die("prefix '#{PREFIX}' のキーが export にもオリジナルにも見つからない。prefix を確認すること。") if merged_by_locale.empty?
 
 # ---- (2) 静的ガード（書き出し前にできる検証を先に。中途半端な --out を残さない）----
 # --out が次回起動時に Rails の i18n glob でロードされる場所か（採番ミス・配置ミスの検出）。
@@ -206,7 +208,10 @@ merged_by_locale.each do |locale, merged|
   non_matching = leaf_entries(merged).keys.grep_v(regexp)
   next if non_matching.empty?
 
-  die("locale #{locale}: regexp #{regexp.inspect} にマッチしない leaf キーがある（regexp/prefix 不一致）:\n  #{non_matching.join("\n  ")}")
+  die(
+    "locale #{locale}: regexp #{regexp.inspect} にマッチしない leaf キーがある（regexp/prefix 不一致）:\n  " \
+    "#{non_matching.join("\n  ")}"
+  )
 end
 
 # 書き出し（ここまでの検証を通過してから）。merged_by_locale は { "ja" => {...}, "en" => {...} } 形なので
@@ -217,7 +222,9 @@ puts "配置: #{out_path} （locale #{merged_by_locale.keys.join(',')} / leaf
 
 # YAML ラウンドトリップ（to_yaml → 再読込で各 locale の merged と一致するか）。
 merged_by_locale.each do |locale, merged|
-  die("YAML ラウンドトリップ不一致。書き出し結果が壊れている: #{out_path} (locale #{locale})") unless load_locale_tree(out_path, locale) == merged
+  next if load_locale_tree(out_path, locale) == merged
+
+  die("YAML ラウンドトリップ不一致。書き出し結果が壊れている: #{out_path} (locale #{locale})")
 end
 
 # ---- (3) 移行漏れ検証（削除をメモリ上でシミュレート）----

data/skills/copy-tuner-to-t-migrate/scripts/migrate_tt.rb

@@ -86,7 +86,7 @@ RELATIVE_KEY_RE = /\btt\b\s*(?:\(\s*)?['":]\s*\./
 # Rewriter(大文字 ⟦CT: 固定)の除去網をすり抜け画面に残る。I18n.t 化では直らない。
 # 正しい修正は method 名を第一引数・表示テキストを第二引数へ分離すること。
 LABEL_FIRST_ARG_RE = /
-  (?: (?<![\w.])\w+\.label\b | \blabel_tag\b | (?<![\w.])label(?![\w]) )
+  (?: (?<![\w.])\w+\.label\b | \blabel_tag\b | (?<![\w.])label(?!\w) )
   \s*\(?\s*
   tt\b (?=\s*[("':@])
 /x
@@ -110,14 +110,14 @@ def scan_file(path, in_app:)
     next unless line =~ TT_CALL
 
     entry = { file: rel, lineno: idx + 1, code: line.rstrip }
-    yield(classify_line(line, entry, in_app: in_app))
+    yield(classify_line(line, entry, in_app:))
   end
 rescue StandardError
   nil
 end
 
 # ヒット 1 行を分類し、[:safe | :suspicious | :other, entry] を返す。
-def classify_line(line, entry, in_app:)
+def classify_line(line, entry, in_app:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   # tt の定義（def/alias）は呼び出しではない。t( へ置換すると Rails の t を壊すので絶対に自動変換しない。
   if line.match?(TT_DEFINITION)
     entry[:reason] = 'tt の定義（def/alias）。自動変換禁止。呼び出しを全て t へ移した後に手動で削除する'
@@ -143,15 +143,16 @@ def classify_line(line, entry, in_app:)
 
   entry[:kind] = :string_manipulation
   entry[:relative_key] = line.match?(RELATIVE_KEY_RE)
-  entry[:hint] = if entry[:relative_key]
-                   'I18n.t へ。相対キー(.foo)は絶対キーへ書き換えが必要'
-                 else
-                   'I18n.t(絶対キー) へ置換を検討'
-                 end
+  entry[:hint] =
+    if entry[:relative_key]
+      'I18n.t へ。相対キー(.foo)は絶対キーへ書き換えが必要'
+    else
+      'I18n.t(絶対キー) へ置換を検討'
+    end
   [:suspicious, entry]
 end
 
-buckets = { safe: safe, suspicious: suspicious, other: other }
+buckets = { safe:, suspicious:, other: }
 Dir.glob(ALL_GLOB).each do |path|
   # vendor / node_modules / tmp 等のノイズを除外
   next if relative(path).start_with?('vendor/', 'node_modules/', 'tmp/', '.git/')
@@ -163,7 +164,7 @@ end
 
 if options[:json]
   require 'json'
-  puts JSON.pretty_generate(safe: safe, suspicious: suspicious, other: other)
+  puts JSON.pretty_generate(safe:, suspicious:, other:)
   exit(0)
 end
 
@@ -172,13 +173,14 @@ def print_section(title, entries)
   entries.each do |e|
     # hint があれば必ず kind も付く（classify_line で対で設定）ので素直に出す。
     # suspicious 内のサブ種別(label_arg / string_manipulation)を可視化する。
-    suffix = if e[:hint]
-               "  # [#{e[:kind]}] #{e[:hint]}"
-             elsif e[:reason]
-               "  # #{e[:reason]}"
-             else
-               ''
-             end
+    suffix =
+      if e[:hint]
+        "  # [#{e[:kind]}] #{e[:hint]}"
+      elsif e[:reason]
+        "  # #{e[:reason]}"
+      else
+        ''
+      end
     puts "#{e[:file]}:#{e[:lineno]}: #{e[:code].strip}#{suffix}"
   end
 end