copy_tuner_incompatible_search 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfaa3ca7e233984dde7c77ea02cd22817a7c9fc1dce97b2c14c926dc7636f86
-  data.tar.gz: 54b63e786512d5854f8f28a5cfbb6efe8c2d7bb4aa8fc4b380dcfed19867df70
+  metadata.gz: ea523148710e0770c70a4777d23d84ae93b02c1d7e4d92e7b96080f0a2188a6f
+  data.tar.gz: c5f2a3729156ca2dfe2871e6f78776bd0996772c1e123209f1ecf46126a2fbc8
 SHA512:
-  metadata.gz: 7ad386c722b6f559b4b23b1abe642421c7ccb1d0d7b5540f6b7e2d1fffed8a307ac18be450583395f87825819ee2e72d65abb005ddbe32efc24b55cba66f2ff7
-  data.tar.gz: 6924441484d3a2a6e25572efab8eab590669fd39187cd092a8147722279c34510a70654b93c7c08e2befbe50108c03d6bb0285355296eaa626a8c2097f66e660
+  metadata.gz: d615646ece07c67dee19035058beffe7c57608477d247faf1eac486aaefcbe860fb25cbe1d2a4f686b52a3e81901501796742f7f8682408b268a8b379988a7f5
+  data.tar.gz: 63a79cdd22595f74d16faf6f4337ac9be4939539adf230cdd0ed7616d113e8a560b33e4c07a51d98a7cbd211a7434a59b7dd21d68ea4da1b2baf99cb16f881ef

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: enable
+inherit_gem:
+  sgcop: ruby/rubocop.yml
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+Bundler/GemComment:
+    Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/ReceiveMessages:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/exe/copy_tuner_incompatible_search

@@ -2,4 +2,9 @@
 
 require_relative '../lib/copy_tuner_incompatible_search/command'
 
-CopyTunerIncompatibleSearch::Command.run
+project_name = File.basename(Dir.pwd)
+timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+output_path = "tmp/usages-#{project_name}-#{timestamp}.xlsx"
+CopyTunerIncompatibleSearch::Command.run(output_path)
+puts "open #{output_path}"
+`open #{output_path}`

data/lib/copy_tuner_incompatible_search/command.rb

@@ -1,56 +1,23 @@
 # frozen_string_literal: true
 
+require 'axlsx'
 require 'set'
 
 module CopyTunerIncompatibleSearch
   class Command
-    def self.run
-      self.new.run
+    def self.run(output_path)
+      self.new.run(output_path)
     end
 
-    def run
-      puts "Start"
-
-      stdout = `rails copy_tuner:detect_html_incompatible_keys`
-      keys = stdout.lines(chomp: true).map do |line|
-        line.split(".", 2).last
-      end.uniq.sort
-      keys = Set[*keys]
-
-      # 完全一致する翻訳キー
-      puts "Searching #{keys.count} keys"
-      count = 0
-      results = {}
-      keys.each do |key|
-        count += 1
-        puts "#{count} / #{keys.count}" if count % 100 == 0
-
-        results[key] ||= Result.new(:static, key)
-        result = `git grep -n "#{Regexp.escape(key)}"`.strip
-        unless result.empty?
-          results[key].add_usage(result)
-        end
-      end
-
-      # .で始まる翻訳キー
-      grep_result = `git grep -n -P "\\btt?[ \\(]['\\"]\\.\\w+"`
-      results['lazy'] = Result.new(:lazy, "")
-      results['lazy'].add_usage(grep_result)
-
-      # 変数を含む翻訳キー
-      grep_result = `git grep -n -P "\\btt?[ \\(]['\\"][\\w.-]*[#$]"`
-      results['with vars'] = Result.new(:dynamic, "")
-      results['with vars'].add_usage(grep_result)
-
-      # Excelに出力
-      project_name = File.basename(Dir.pwd)
-      timestamp = Time.now.strftime("%Y%m%d%H%M%S")
-      output_path = "tmp/usages-#{project_name}-#{timestamp}.xlsx"
-      dump_to_xlsx(results, keys, output_path)
-
-      puts "Finish"
-      puts "open #{output_path}"
-      `open #{output_path}`
+    def run(output_path)
+      puts 'Start'
+      incompatible_keys = search_incompatible_keys
+      results = search_static_usages(incompatible_keys)
+      results << search_lazy_usages
+      results << search_dynamic_usages
+      ignored_keys = Set[*eval(ignored_keys_text)] # rubocop:disable Security/Eval
+      XlsxWriter.dump_to_xlsx(results, incompatible_keys, ignored_keys, output_path)
+      puts 'Finish'
     end
 
     private
@@ -64,6 +31,10 @@ module CopyTunerIncompatibleSearch
         @usages = []
       end
 
+      def static?
+        @type == :static
+      end
+
       def lazy?
         @type == :lazy
       end
@@ -89,7 +60,7 @@ module CopyTunerIncompatibleSearch
       attr_reader :file, :line, :code, :lazy_key
 
       def initialize(grep_result, lazy_key = nil)
-        file, line, code = grep_result.split(":", 3)
+        file, line, code = grep_result.split(':', 3)
         @file = file
         @line = line
         @code = code.strip
@@ -97,53 +68,62 @@ module CopyTunerIncompatibleSearch
       end
     end
 
-    def ignored_keys
-      @ignored_keys ||= begin
-                          text = `rails r "p CopyTunerClient::configuration.ignored_keys"`
-                          Set[*eval(text)]
-                        end
+    def search_incompatible_keys
+      stdout = detect_html_incompatible_keys
+      keys = stdout.lines(chomp: true).map do |line|
+        line.split('.', 2).last
+      end.uniq.sort
+      Set[*keys]
     end
 
-    def dump_to_xlsx(results, keys, output_path)
-      Axlsx::Package.new do |p|
-        p.workbook.add_worksheet(name: "Data") do |sheet|
-          monospace_style = sheet.styles.add_style(font_name: 'Courier New', sz: 14)
-          sheet.add_row ["Type", "Key", "Ignored", "File", "Line", "Code"], style: monospace_style
-          sheet.auto_filter = "A1:F1"
-
-          # freeze pane
-          sheet.sheet_view.pane do |pane|
-            pane.top_left_cell = 'A2'
-            pane.state = :frozen_split
-            pane.y_split = 1
-            pane.x_split = 0
-            pane.active_pane = :bottom_right
-          end
+    def search_static_usages(incompatible_keys)
+      puts "Searching #{incompatible_keys.count} keys"
+      count = 0
+      incompatible_keys.map do |key|
+        count += 1
+        puts "#{count} / #{incompatible_keys.count}" if (count % 100).zero?
 
-          results.each do |key, result|
-            added = false
-            result.usages.each do |usage|
-              key = if result.lazy?
-                      path = usage.file.sub(/^app\/views\//, '').sub(/\..+$/, '').sub('/_', '/').gsub('/', '.')
-                      path + usage.lazy_key
-                    else
-                      result.key
-                    end
-              already_migrated = usage.file == 'config/initializers/copy_tuner.rb' || usage.code.include?("#{usage.lazy_key || result.key}_html")
-              if (!result.lazy? || keys.include?(key)) && !already_migrated
-                ignored = unless result.dynamic? then ignored_keys.include?(key) ? "Y" : "N" end
-                sheet.add_row [result.type, key, ignored.to_s, usage.file, usage.line, usage.code], style: monospace_style
-                added = true
-              end
-            end
-            if !added && !result.lazy?
-              ignored = ignored_keys.include?(result.key) ? "Y" : "N"
-              sheet.add_row [result.type, result.key, ignored.to_s, "", "", ""], style: monospace_style
-            end
-          end
+        result = Result.new(:static, key)
+        usage = grep_usage(key).strip
+        unless usage.empty?
+          result.add_usage(usage)
         end
-        p.serialize(output_path)
+        result
       end
     end
+
+    def search_lazy_usages
+      grep_result = grep_lazy_keys
+      result = Result.new(:lazy, '')
+      result.add_usage(grep_result)
+      result
+    end
+
+    def search_dynamic_usages
+      grep_result = grep_dynamic_keys
+      result = Result.new(:dynamic, '')
+      result.add_usage(grep_result)
+      result
+    end
+
+    def detect_html_incompatible_keys
+      `rails copy_tuner:detect_html_incompatible_keys`
+    end
+
+    def grep_lazy_keys
+      `git grep -n -P "\\btt?[ \\(]['\\"]\\.\\w+"`
+    end
+
+    def grep_dynamic_keys
+      `git grep -n -P "\\btt?[ \\(]['\\"][\\w.-]*[#$]"`
+    end
+
+    def grep_usage(key)
+      `git grep -n "#{Regexp.escape(key)}"`
+    end
+
+    def ignored_keys_text
+      `rails r "p CopyTunerClient::configuration.ignored_keys"`
+    end
   end
 end

data/lib/copy_tuner_incompatible_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CopyTunerIncompatibleSearch
-  VERSION = "0.1.1"
+  VERSION = '0.1.3'
 end

data/lib/copy_tuner_incompatible_search/xlsx_writer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module CopyTunerIncompatibleSearch
+  class XlsxWriter
+    def self.dump_to_xlsx(results, incompatible_keys, ignored_keys, output_path)
+      self.new(results, incompatible_keys, ignored_keys).dump_to_xlsx(output_path)
+    end
+
+    def initialize(results, incompatible_keys, ignored_keys)
+      @results = results
+      @incompatible_keys = incompatible_keys
+      @ignored_keys = ignored_keys
+    end
+
+    def dump_to_xlsx(output_path)
+      Axlsx::Package.new do |p|
+        p.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'
+          freeze_pane(sheet)
+
+          results.each do |result|
+            add_result_rows(sheet, result, style)
+          end
+        end
+        p.serialize(output_path)
+      end
+    end
+
+    private
+
+    attr_reader :results, :incompatible_keys, :ignored_keys
+
+    def freeze_pane(sheet)
+      sheet.sheet_view.pane do |pane|
+        pane.top_left_cell = 'A2'
+        pane.state = :frozen_split
+        pane.y_split = 1
+        pane.x_split = 0
+        pane.active_pane = :bottom_right
+      end
+    end
+
+    def add_result_rows(sheet, result, style)
+      added = false
+      result.usages.each do |usage|
+        key = build_key(result, usage)
+        next unless should_output?(usage, result, key)
+
+        ignored = ignored_flag(key) unless result.dynamic?
+        sheet.add_row [result.type, key, ignored.to_s, usage.file, usage.line, usage.code], style: style
+        added = true
+      end
+      if !added && result.static?
+        sheet.add_row [result.type, result.key, ignored_flag(result.key), '', '', ''], style: style
+      end
+    end
+
+    def build_key(result, usage)
+      if result.lazy?
+        path = usage.file.sub(%r{^app/views/}, '').sub(/\..+$/, '').sub('/_', '/').gsub('/', '.')
+        path + usage.lazy_key
+      else
+        result.key
+      end
+    end
+
+    def should_output?(usage, result, key)
+      already_migrated = usage.file == 'config/initializers/copy_tuner.rb' || usage.code.include?("#{usage.lazy_key || result.key}_html")
+      (!result.lazy? || incompatible_keys.include?(key)) && !already_migrated
+    end
+
+    def ignored_flag(key)
+      ignored_keys.include?(key) ? 'Y' : 'N'
+    end
+  end
+end

data/lib/copy_tuner_incompatible_search.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "copy_tuner_incompatible_search/version"
-require_relative "copy_tuner_incompatible_search/command"
+require_relative 'copy_tuner_incompatible_search/version'
+require_relative 'copy_tuner_incompatible_search/command'
+require_relative 'copy_tuner_incompatible_search/xlsx_writer'
 
 module CopyTunerIncompatibleSearch
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_incompatible_search
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Junichi Ito
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -42,6 +43,7 @@ files:
 - lib/copy_tuner_incompatible_search.rb
 - lib/copy_tuner_incompatible_search/command.rb
 - lib/copy_tuner_incompatible_search/version.rb
+- lib/copy_tuner_incompatible_search/xlsx_writer.rb
 - sig/copy_tuner_incompatible_search.rbs
 homepage: https://github.com/JunichiIto/copy_tuner_incompatible_search
 licenses:
@@ -50,6 +52,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/JunichiIto/copy_tuner_incompatible_search
   changelog_uri: https://github.com/JunichiIto/copy_tuner_incompatible_search/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: