copy_tuner_client 2.1.2 → 2.2.1

data/lib/copy_tuner_client/i18n_backend.rb

@@ -57,7 +57,7 @@ module CopyTunerClient
 
     private
 
-    def lookup(locale, key, scope = [], options = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
+    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])
@@ -68,21 +68,14 @@ module CopyTunerClient
       # ローカル config/locales（I18n::Backend::Simple）を優先する。段階的にローカルへ移行するための仕組み。
       # ローカルに無い場合は nil（未訳）のまま返し、copy_tuner へのフォールバックも空キー登録も行わない（完全分離）。
       # ignored_keys より先に評価することで、両方にマッチするキーでも確実にローカルへ委譲する。
-      if local_first_key?(key_without_locale)
-        return super
-      end
+      return super if local_first_key?(key_without_locale)
 
-      config = CopyTunerClient.configuration
-      if config.ignored_keys.include?(key_without_locale)
-        config.ignored_key_handler.call(IgnoredKey.new("Ignored key: #{key_without_locale}"))
-      end
+      handle_ignored_key(key_without_locale)
 
       # NOTE: ハッシュ化した場合に削除されるキーに対応するため、最初に完全一致をチェック（旧クライアントの動作を維持）
       # 例: `en.test.key` が `en.test.key.conflict` のように別のキーで上書きされている場合の対応
       exact_match = cache[key_with_locale]
-      if exact_match
-        return exact_match
-      end
+      return exact_match if exact_match
 
       ensure_tree_cache_current
       tree_result = lookup_in_tree_cache(parts)
@@ -90,13 +83,18 @@ module CopyTunerClient
 
       content = super
 
-      if content.nil?
-        cache[key_with_locale] = nil
-      end
+      cache[key_with_locale] = nil if content.nil?
 
       content
     end
 
+    def handle_ignored_key(key_without_locale)
+      config = CopyTunerClient.configuration
+      return unless config.ignored_keys.include?(key_without_locale)
+
+      config.ignored_key_handler.call(IgnoredKey.new("Ignored key: #{key_without_locale}"))
+    end
+
     def ensure_tree_cache_current
       current_version = cache.version
       # ETag が nil の場合（初回ダウンロード前）や変更があった場合のみ更新

data/lib/copy_tuner_client/i18n_compat.rb

@@ -1,10 +1,11 @@
 require 'nokogiri'
 
 module CopyTunerClient
+  # `_html` サフィックス無しに HTML タグを含む訳文（i18n の HTML 安全規約違反）を検出する
   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|
+      non_html_key_blurbs.select do |_key, content|
         Nokogiri::HTML.fragment(content).children.any? { |node| node.name != 'text' }
       end
     end

data/lib/copy_tuner_client/poller.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'copy_tuner_client/cache'
 require 'copy_tuner_client/queue_with_timeout'
 
@@ -30,7 +29,7 @@ module CopyTunerClient
     def stop
       @mutex.synchronize do
         @command_queue.uniq_push(:stop)
-        @thread.join if @thread
+        @thread&.join
         @thread = nil
       end
     end
@@ -59,8 +58,8 @@ module CopyTunerClient
         end
       end
       @logger.info 'stop poller thread'
-    rescue InvalidApiKey => error
-      logger.error(error.message)
+    rescue InvalidApiKey => e
+      logger.error(e.message)
     end
   end
 end

data/lib/copy_tuner_client/prefixed_logger.rb

@@ -1,4 +1,5 @@
 module CopyTunerClient
+  # ログ出力にプレフィックスとプロセス/スレッド情報を付加する Logger ラッパー
   class PrefixedLogger
     attr_reader :prefix, :original_logger
 
@@ -7,24 +8,24 @@ module CopyTunerClient
       @original_logger = logger
     end
 
-    def info(message = nil, &block)
-      log(:info, message, &block)
+    def info(message = nil, &)
+      log(:info, message, &)
     end
 
-    def debug(message = nil, &block)
-      log(:debug, message, &block)
+    def debug(message = nil, &)
+      log(:debug, message, &)
     end
 
-    def warn(message = nil, &block)
-      log(:warn, message, &block)
+    def warn(message = nil, &)
+      log(:warn, message, &)
     end
 
-    def error(message = nil, &block)
-      log(:error, message, &block)
+    def error(message = nil, &)
+      log(:error, message, &)
     end
 
-    def fatal(message = nil, &block)
-      log(:fatal, message, &block)
+    def fatal(message = nil, &)
+      log(:fatal, message, &)
     end
 
     def flush
@@ -33,9 +34,9 @@ module CopyTunerClient
 
     private
 
-    def log(severity, message, &block)
+    def log(severity, message, &)
       prefixed_message = "#{prefix} #{thread_info} #{message}"
-      original_logger.send(severity, prefixed_message, &block)
+      original_logger.public_send(severity, prefixed_message, &)
     end
 
     def thread_info

data/lib/copy_tuner_client/process_guard.rb

@@ -3,7 +3,7 @@ module CopyTunerClient
   # process (such as in Unicorn or Passenger). Also registers hooks for exiting
   # processes and completing background jobs. Applications using the client
   # will not need to interact with this class directly.
-  class ProcessGuard
+  class ProcessGuard # rubocop:disable Metrics/ClassLength
     # @param options [Hash]
     # @option options [Logger] :logger where errors should be logged
     def initialize(cache, poller, options)
@@ -33,15 +33,16 @@ module CopyTunerClient
     end
 
     def passenger_spawner?
-      defined?(PhusionPassenger) && ($0.include?("Passenger AppPreloader") || $0.include?("ApplicationSpawner") || $0.include?("rack-preloader"))
+      defined?(PhusionPassenger) &&
+        ['Passenger AppPreloader', 'ApplicationSpawner', 'rack-preloader'].any? { |name| $PROGRAM_NAME.include?(name) }
     end
 
     def unicorn_spawner?
-      defined?(Unicorn::HttpServer) && ($0.include?("unicorn") && !caller.any? { |line| line.include?("worker_loop") })
+      defined?(Unicorn::HttpServer) && $PROGRAM_NAME.include?('unicorn') && caller.none? { |line| line.include?('worker_loop') }
     end
 
     def puma_spawner?
-      defined?(Puma::Runner) && $0.include?('puma')
+      defined?(Puma::Runner) && $PROGRAM_NAME.include?('puma')
     end
 
     def delayed_job_spawner?
@@ -49,11 +50,11 @@ module CopyTunerClient
       # - bin/delayed_job start
       # - bin/rake jobs:work
       # 前者の呼び出しでのみジョブ処理用の子プロセスが作られるため、　poller を作るフックを仕込む必要がある。
-      defined?(Delayed::Worker) && $0.include?('delayed_job')
+      defined?(Delayed::Worker) && $PROGRAM_NAME.include?('delayed_job')
     end
 
     def good_job_spawner?
-      $0.include?('good_job') && defined?(GoodJob) && ARGV.include?('--daemonize')
+      $PROGRAM_NAME.include?('good_job') && defined?(GoodJob) && ARGV.include?('--daemonize')
     end
 
     def register_spawn_hooks
@@ -71,17 +72,17 @@ module CopyTunerClient
     end
 
     def register_passenger_hook
-      @logger.info("Registered Phusion Passenger fork hook")
-      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+      @logger.info('Registered Phusion Passenger fork hook')
+      PhusionPassenger.on_event(:starting_worker_process) do |_forked|
         start_polling
       end
     end
 
     def register_unicorn_hook
-      @logger.info("Registered Unicorn fork hook")
+      @logger.info('Registered Unicorn fork hook')
       poller = @poller
       Unicorn::HttpServer.class_eval do
-        alias_method :worker_loop_without_copy_tuner, :worker_loop
+        alias_method(:worker_loop_without_copy_tuner, :worker_loop)
         define_method :worker_loop do |worker|
           poller.start
           worker_loop_without_copy_tuner(worker)
@@ -90,10 +91,10 @@ module CopyTunerClient
     end
 
     def register_delayed_hook
-      @logger.info("Registered Delayed::Job start hook")
+      @logger.info('Registered Delayed::Job start hook')
       poller = @poller
       Delayed::Worker.class_eval do
-        alias_method :start_without_copy_tuner, :start
+        alias_method(:start_without_copy_tuner, :start)
         define_method :start do
           poller.start
           start_without_copy_tuner
@@ -102,21 +103,22 @@ module CopyTunerClient
     end
 
     def register_good_job_hook
-      @logger.info("Registered good_job start hook")
+      @logger.info('Registered good_job start hook')
       poller = @poller
-      hook_module = Module.new do
-        define_method :daemon do
-          super() # NOTE: define_method 内で super を呼ぶ場合は引数を明示的に指定する必要があるので注意
-          poller.start
+      hook_module =
+        Module.new do
+          define_method :daemon do
+            super() # NOTE: define_method 内で super を呼ぶ場合は引数を明示的に指定する必要があるので注意
+            poller.start
+          end
         end
-      end
-      ::Process.singleton_class.prepend hook_module
+      ::Process.singleton_class.prepend(hook_module)
     end
 
     def register_puma_hook
       # If Puma is clustered mode without preload_app, this method is called on worker process.
       # Just start poller and return.
-      if $0.include?('cluster worker')
+      if $PROGRAM_NAME.include?('cluster worker')
         @logger.info('Puma would be clustered mode without preload_app')
         @poller.start
         return
@@ -126,13 +128,14 @@ module CopyTunerClient
       # If Puma is clustered mode with preload_app, this method is called before fork.
       # Delay poller start until Puma::Runner#start_server which is called on worker process.
       poller = @poller
-      hook_module = Module.new do
-        define_method :start_server do
-          poller.start
-          super() # NOTE: define_method 内で super を呼ぶ場合は引数を明示的に指定する必要があるので注意
+      hook_module =
+        Module.new do
+          define_method :start_server do
+            poller.start
+            super() # NOTE: define_method 内で super を呼ぶ場合は引数を明示的に指定する必要があるので注意
+          end
         end
-      end
-      Puma::Runner.prepend hook_module
+      Puma::Runner.prepend(hook_module)
     end
 
     def register_exit_hooks

data/lib/copy_tuner_client/queue_with_timeout.rb

@@ -7,17 +7,17 @@ module CopyTunerClient
       @received = ConditionVariable.new
     end
 
-    def <<(x)
+    def <<(item)
       @mutex.synchronize do
-        @queue << x
+        @queue << item
         @received.signal
       end
     end
 
-    def uniq_push(x)
+    def uniq_push(item)
       @mutex.synchronize do
-        unless @queue.member?(x)
-          @queue << x
+        unless @queue.member?(item)
+          @queue << item
           @received.signal
         end
       end
@@ -29,22 +29,32 @@ module CopyTunerClient
 
     def pop_with_timeout(timeout = nil)
       @mutex.synchronize do
-        if timeout.nil?
-          # wait indefinitely until there is an element in the queue
-          while @queue.empty?
-            @received.wait(@mutex)
-          end
-        elsif @queue.empty? && timeout != 0
-          # wait for element or timeout
-          timeout_time = timeout + Time.now.to_f
-          while @queue.empty? && (remaining_time = timeout_time - Time.now.to_f) > 0
-            @received.wait(@mutex, remaining_time)
-          end
-        end
-        #if we're still empty after the timeout, raise exception
-        raise ThreadError, "queue empty" if @queue.empty?
+        wait_for_item(timeout)
+
+        # if we're still empty after the timeout, raise exception
+        raise ThreadError, 'queue empty' if @queue.empty?
+
         @queue.shift
       end
     end
+
+    private
+
+    def wait_for_item(timeout)
+      if timeout.nil?
+        # wait indefinitely until there is an element in the queue
+        @received.wait(@mutex) while @queue.empty?
+      elsif @queue.empty? && timeout != 0
+        wait_with_timeout(timeout)
+      end
+    end
+
+    def wait_with_timeout(timeout)
+      # wait for element or timeout
+      timeout_time = timeout + Time.now.to_f
+      while @queue.empty? && (remaining_time = timeout_time - Time.now.to_f).positive?
+        @received.wait(@mutex, remaining_time)
+      end
+    end
   end
 end

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.2'.freeze
+  VERSION = '2.2.1'.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)