copy_tuner_incompatible_search 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deec2ce275a80adfa8b8cc254f8c1c231b24f105f135c9562879bc3e97594f27
-  data.tar.gz: 3be254a36173f790085c55b5c16faf630037772adb462ea235228b63c620c628
+  metadata.gz: bc4286519e2113ead29b31af8cf83dfd670a7c6f6f9c6bdc64a04521761449c8
+  data.tar.gz: b3d299b35e57cab0718788e1835b5d9c962af93bce74949fe178b235406472d1
 SHA512:
-  metadata.gz: f25cdab6e4336dfd507b00091758c4bdde845db9f642ea1a2ebfd80d76a421a85a6d9e6a250bfd30b48ce77ed9f909d40be257701a1f5c86134b6695a6d0c6a9
-  data.tar.gz: d8a375d7f39a73e526c352c94acafad366bed3e74eb811be7c9685189ecec68ca58bba5f8824a2a54390d8ee4ede049e1b3da61e288359f0db0fa7212613ee06
+  metadata.gz: d444bc38349d99fecda3dd7f5bf6380809291f8f33b086a258ce7a32b86e454606028743763ef1f28b02cb1f822a831820e304ea3e26b928ab7a5f87aa3c4362
+  data.tar.gz: e251abc409a2d201075202ded4a7f1659664aa9ed37b3b9557cc79c83c891f92a0c23b2f77bae137db3150fa65348963aafab9e0be4b2c86222ee7de1fe81da8

data/.rubocop.yml

@@ -14,3 +14,11 @@ RSpec/ReceiveMessages:
   Enabled: false
 RSpec/NestedGroups:
   Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [Unreleased]
+## [2.0.0] - 2024-05-03
+
+- Add command copy_tuner_incompatible_replace 
+
 ## [1.0.0] - 2024-04-28
 
 - Release the first version 

data/README.md

@@ -20,6 +20,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     copy_tuner_incompatible_search
 
+    copy_tuner_incompatible_replace <usage.xlsx> <blurbs.csv>
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Steepfile

@@ -29,5 +29,7 @@
 # end
 target :lib do
   check 'lib'
+  # すぐにrbsを導入するのは難しそうなのであとまわし
+  ignore 'lib/copy_tuner_incompatible_search/replace_command.rb'
   signature 'sig'
 end

data/exe/copy_tuner_incompatible_replace

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/copy_tuner_incompatible_search'
+
+def show_keys(keys)
+  if keys.empty?
+    puts 'なし'
+  else
+    puts keys.uniq.sort
+  end
+  puts
+end
+
+project_name = File.basename(Dir.pwd)
+timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+output_path = "tmp/with-html-suffix-#{project_name}-#{timestamp}.csv"
+usage_path = ARGV[0]
+blurbs_path = ARGV[1]
+if usage_path.nil? || blurbs_path.nil?
+  puts 'Please specify file paths: copy_tuner_incompatible_replace <usage_xlsx> <blurbs_csv>'
+  puts 'usage_xlsx can be created by copy_tuner_incompatible_search'
+  puts 'blurbs_csv can be downloaded from CopyTuner server'
+  exit 1
+end
+result = CopyTunerIncompatibleSearch::ReplaceCommand.run(usage_path, blurbs_path, output_path)
+
+puts "非互換のキーを_html付きのキーに変換したので、#{output_path}をCopyTunerにアップロードする。コードも置換済み"
+show_keys result.newly_replaced_keys
+
+puts '非互換だが、すでに_htmlまたは.htmlつきのキーが存在していたので、コードの置換のみ実行'
+show_keys result.existing_keys
+
+puts '使用箇所を見つけられなかったキー。手動で使用箇所を特定し、手動で_html付きのキーを作成する'
+show_keys result.not_used_incompatible_keys
+
+puts '非互換のキーはconfig.ignored_keysに追加する'
+show_keys result.keys_to_ignore
+
+puts '以下のキーはすでにconfig.ignored_keysに追加済み'
+show_keys result.already_ignored_keys
+
+puts '特殊文字を含むキー。手動で使用箇所を特定し、手動で_html付きのキーを作成する。config.ignored_keys にも追加する'
+show_keys result.keys_with_special_chars
+
+puts '動的なキーが使われている箇所の数。手動で使用箇所を特定し、手動で_html付きのキーを作成する'
+puts result.dynamic_count

data/lib/copy_tuner_incompatible_search/replace_command.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'set'
+
+require 'roo'
+
+module CopyTunerIncompatibleSearch
+  class ReplaceCommand # rubocop:disable Metrics/ClassLength
+    def self.run(usage_path, blurbs_path, output_path)
+      self.new(usage_path, blurbs_path).run(output_path)
+    end
+
+    def initialize(usage_path, blurbs_path)
+      @usage_path = usage_path
+      @blurbs_path = blurbs_path
+    end
+
+    def run(output_path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # usages.xlsxから生成したUsageオブジェクトの配列
+      usages = usage_sheet.each(type: 'Type', key: 'Key', ignored: 'Ignored', file: 'File', line: 'Line').filter_map.with_index do |hash, i|
+        next if i.zero? # skip header
+
+        Usage.new(**hash)
+      end
+      # プロジェクト内で後方互換性のないキーの集合
+      incompatible_keys = Set[*usages.select(&:static?).map(&:key)]
+      # 使用箇所が判明しているUsageオブジェクトの配列（ただし、dynamicなキーを除く）
+      used_usages = usages.select(&:used?)
+      # _html付きのキーに変換する必要があるキーの集合
+      keys_to_convert = Set[*used_usages.map(&:key)]
+      # staticかつ使用箇所が判明しているUsageオブジェクトの配列を翻訳キーでグループ化
+      static_usages_by_key = used_usages.select(&:static?).group_by(&:key)
+      # lazyかつ使用箇所が判明しているUsageオブジェクトの配列を翻訳キーでグループ化
+      lazy_usages_by_key = used_usages.select(&:lazy?).group_by(&:key)
+
+      # blurbs.csvの全キーの集合と、特殊文字を含むキーの配列
+      all_blurb_keys, keys_with_special_chars = parse_blurbs_csv
+      # すでに_htmlで終わるキーが存在する後方互換性のないキーの集合
+      underscore_converted_keys = Set[*incompatible_keys.select { |k| all_blurb_keys.include?("#{k}_html") }]
+      # すでに.htmlで終わるキーが存在する後方互換性のないキーの集合
+      dot_converted_keys = Set[*incompatible_keys.select { |k| all_blurb_keys.include?("#{k}.html") }]
+
+      # コード上のキーを置換する必要があるキーの配列
+      keys_for_code_replace = []
+      # _html付きのキーを新たに登録しなければならないキーの配列
+      newly_replaced_keys = []
+      # 使用箇所が見つからなかった後方互換性のないキーの配列
+      not_used_incompatible_keys = []
+      # _html付きのキーを定義したCSVを保存する。このファイルはCopyTunerにアップロードするために使う
+      CSV.open(output_path, 'wb') do |csv_out|
+        CSV.parse(blurbs_csv_text, headers: true, quote_char: '"').each_with_index do |row, i|
+          if i.zero?
+            csv_out << row.headers
+          end
+          key = row[0]
+          converted_key = "#{key}_html"
+          if keys_to_convert.include?(key) && !dot_converted_keys.include?(key) && !underscore_converted_keys.include?(key)
+            csv_out << [converted_key, *row[1..]]
+            newly_replaced_keys << key
+          end
+          if keys_to_convert.include?(key)
+            keys_for_code_replace << key
+          elsif incompatible_keys.include?(key)
+            not_used_incompatible_keys << key
+          end
+        end
+      end
+
+      replace_code_for_static_usages(static_usages_by_key, keys_for_code_replace, underscore_converted_keys, dot_converted_keys)
+      replace_code_for_lazy_usages(lazy_usages_by_key, keys_for_code_replace, underscore_converted_keys, dot_converted_keys)
+
+      existing_keys = keys_for_code_replace - newly_replaced_keys
+      already_ignored_keys = search_ignored_keys.uniq
+      keys_to_ignore = usages.reject(&:dynamic?).map(&:key).uniq - already_ignored_keys
+      dynamic_count = usages.count(&:dynamic?)
+      Result.new(newly_replaced_keys, existing_keys, not_used_incompatible_keys, keys_to_ignore, already_ignored_keys, keys_with_special_chars, dynamic_count)
+    end
+
+    private
+
+    attr_reader :usage_path, :blurbs_path
+
+    class Usage
+      attr_reader :type, :key, :file, :line
+
+      def initialize(type:, key:, ignored:, file:, line:)
+        @type = type
+        @key = key
+        @ignored = ignored
+        @file = file
+        @line = line.to_s.empty? ? nil : line.to_i
+      end
+
+      def static?
+        @type == 'static'
+      end
+
+      def lazy?
+        @type == 'lazy'
+      end
+
+      def dynamic?
+        @type == 'dynamic'
+      end
+
+      def used?
+        !dynamic? && !@file.to_s.strip.empty?
+      end
+
+      def lazy_key
+        return unless lazy?
+
+        last_key = key.split('.').last
+        ".#{last_key}"
+      end
+    end
+
+    class Result
+      attr_reader :newly_replaced_keys, :existing_keys, :not_used_incompatible_keys, :keys_to_ignore, :already_ignored_keys, :keys_with_special_chars,
+                  :dynamic_count
+
+      def initialize(newly_replaced_keys, existing_keys, not_used_incompatible_keys, keys_to_ignore, already_ignored_keys, keys_with_special_chars, dynamic_count) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
+        @newly_replaced_keys = newly_replaced_keys
+        @existing_keys = existing_keys
+        @not_used_incompatible_keys = not_used_incompatible_keys
+        @keys_to_ignore = keys_to_ignore
+        @already_ignored_keys = already_ignored_keys
+        @keys_with_special_chars = keys_with_special_chars
+        @dynamic_count = dynamic_count
+      end
+    end
+
+    def usage_sheet
+      actual_xlsx = Roo::Spreadsheet.open(usage_path)
+      actual_xlsx.sheet(0)
+    end
+
+    def blurbs_csv_text
+      File.read(blurbs_path)
+    end
+
+    def search_ignored_keys
+      eval(ignored_keys_text) # rubocop:disable Security/Eval
+    end
+
+    def ignored_keys_text
+      `rails r "p CopyTunerClient::configuration.ignored_keys"`
+    end
+
+    def parse_blurbs_csv
+      keys_with_special_chars = []
+      all_blurb_keys = []
+      CSV.parse(blurbs_csv_text, headers: true, quote_char: '"').each do |row|
+        # FIXME: なぜか文字列で指定すると取得できない
+        # row['key']
+        key = row[0]
+        all_blurb_keys << key
+        translation = row[1]
+        if translation.match?(/&#\d+;|&\w+;/) && !key.match?(/[_.]html$/)
+          keys_with_special_chars << key
+        end
+      end
+      [Set[*all_blurb_keys], keys_with_special_chars]
+    end
+
+    def replace_code_for_lazy_usages(lazy_usages_by_key, keys_for_code_replace, underscore_converted_keys, dot_converted_keys)
+      lazy_usages_by_key.each do |key, usages|
+        next unless keys_for_code_replace.include?(key)
+
+        usages.each do |usage|
+          replace_code(usage, underscore_converted_keys, dot_converted_keys)
+        end
+      end
+    end
+
+    def replace_code_for_static_usages(static_usages_by_key, keys_for_code_replace, underscore_converted_keys, dot_converted_keys)
+      static_usages_by_key.each do |key, usages|
+        next unless keys_for_code_replace.include?(key)
+
+        usages.each do |usage|
+          replace_code(usage, underscore_converted_keys, dot_converted_keys)
+        end
+      end
+    end
+
+    def replace_code(usage, underscore_converted_keys, dot_converted_keys)
+      lines = file_readlines(usage.file)
+      if usage.lazy?
+        lazy_key = usage.lazy_key
+        regex = /(?<=['"])#{Regexp.escape(lazy_key)}(?=['"])/
+      else
+        regex = /(?<=['"])#{Regexp.escape(usage.key)}(?=['"])/
+      end
+      new_key = generate_html_key(usage, underscore_converted_keys, dot_converted_keys)
+      lines[usage.line - 1].gsub!(regex, new_key)
+      file_write(usage.file, lines.join)
+    end
+
+    def file_readlines(path)
+      File.readlines(path)
+    end
+
+    def file_write(path, text)
+      File.write(path, text)
+    end
+
+    # すでに_htmlまたは.htmlのキーが存在していればそのキーを、そうでなければ_html付きのキーを返す
+    def generate_html_key(usage, underscore_converted_keys, dot_converted_keys)
+      has_underscore = underscore_converted_keys.include?(usage.key)
+      has_dot = dot_converted_keys.include?(usage.key)
+      none = !has_underscore && !has_dot
+      key = usage.lazy? ? usage.lazy_key : usage.key
+      has_underscore || none ? "#{key}_html" : "#{key}.html"
+    end
+  end
+end

data/lib/copy_tuner_incompatible_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CopyTunerIncompatibleSearch
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/copy_tuner_incompatible_search/xlsx_writer.rb

@@ -9,8 +9,8 @@ module CopyTunerIncompatibleSearch
     end
 
     def save_to(output_path)
-      Axlsx::Package.new do |p|
-        p.workbook.add_worksheet(name: 'Data') do |sheet|
+      Axlsx::Package.new do |pkg|
+        pkg.workbook.add_worksheet(name: 'Data') do |sheet|
           style = sheet.styles.add_style(font_name: 'Courier New', sz: 14)
           sheet.add_row %w[Type Key Ignored File Line Code], style: style
           sheet.auto_filter = 'A1:F1'
@@ -20,7 +20,7 @@ module CopyTunerIncompatibleSearch
             add_result_rows(sheet, result, style)
           end
         end
-        p.serialize(output_path)
+        pkg.serialize(output_path)
       end
     end
 

data/lib/copy_tuner_incompatible_search.rb

@@ -3,6 +3,7 @@
 require_relative 'copy_tuner_incompatible_search/version'
 require_relative 'copy_tuner_incompatible_search/command'
 require_relative 'copy_tuner_incompatible_search/xlsx_writer'
+require_relative 'copy_tuner_incompatible_search/replace_command'
 
 module CopyTunerIncompatibleSearch
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_incompatible_search
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Junichi Ito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx
@@ -28,6 +28,7 @@ description:
 email:
 - jit@sonicgarden.jp
 executables:
+- copy_tuner_incompatible_replace
 - copy_tuner_incompatible_search
 extensions: []
 extra_rdoc_files: []
@@ -40,9 +41,11 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- exe/copy_tuner_incompatible_replace
 - exe/copy_tuner_incompatible_search
 - lib/copy_tuner_incompatible_search.rb
 - lib/copy_tuner_incompatible_search/command.rb
+- lib/copy_tuner_incompatible_search/replace_command.rb
 - lib/copy_tuner_incompatible_search/version.rb
 - lib/copy_tuner_incompatible_search/xlsx_writer.rb
 - sig/copy_tuner_incompatible_search.rbs