copy_tuner_incompatible_search 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0d80ab1633aaac8dce000b96a11d5d7c7a133f5b07c241ba1426178b4f9d63
-  data.tar.gz: ac0e9f7149cb519a9a4ad23b45db1c17cbe0b008c278c5a09821e74190f01876
+  metadata.gz: 6bf1eb19d25dd77c7a6bfd5f190f2ae6d2528290a4e4aa738694a8472177420d
+  data.tar.gz: 1b8e382f5cf7b855b3676981ca01fda08e141b4b217679eb6580b9b3797f534b
 SHA512:
-  metadata.gz: 115e471c21e4d4832209b9cfbae972dd0c648fb8cfc46ed2d385bc8a2f0a17fb6475827491bcf24b7b633e2f95523e6153a1dc56b4e371dae86d2024bdf452d1
-  data.tar.gz: e52b3f4e1c912665375985e09ed6def6055d6625567c478977c244408dffeade150bccea1c17e57199f5efde70e8fcd786382d98b0a75aab719a19ff220decac
+  metadata.gz: 4f6a71993756a555c2d1fb1419c2a7fd08ce9deba72f99f604e68eae718afbcfe4388dc1f63f4aec77db29a27cfe866b8a5e92602740467b0c1c8fcb6781d10e
+  data.tar.gz: f86654919bc9399476f88bbe63d753f1d400a7c6ff4c2692c50014e9c574d35b25825f74d96b0d2a73d47ef0b47fdbd3fda7264e302cf4c3903d563e919eb7de

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 ## [Unreleased]
+## [0.1.5] - 2024-04-28
+
+- Refactor the code
 
 ## [0.1.0] - 2024-04-27
 

data/README.md

@@ -1,24 +1,24 @@
-# CopyTunerIncompatibleSearch
+![](https://github.com/JunichiIto/copy_tuner_incompatible_search/actions/workflows/rspec.yml/badge.svg)
+![](https://github.com/JunichiIto/copy_tuner_incompatible_search/actions/workflows/rubocop.yml/badge.svg)
+![](https://github.com/JunichiIto/copy_tuner_incompatible_search/actions/workflows/steep.yml/badge.svg)
 
-TODO: Delete this and the text below, and describe your gem
+# CopyTunerIncompatibleSearch
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/copy_tuner_incompatible_search`. To experiment with that code, run `bin/console` for an interactive prompt.
+Search usage of incompatible keys in CopyTuner.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add copy_tuner_incompatible_search
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install copy_tuner_incompatible_search
 
 ## Usage
 
-TODO: Write usage instructions here
+    copy_tuner_incompatible_search
 
 ## Development
 
@@ -28,7 +28,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/copy_tuner_incompatible_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/copy_tuner_incompatible_search/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/JunichiIto/copy_tuner_incompatible_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/copy_tuner_incompatible_search/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/Steepfile

@@ -0,0 +1,33 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname"              # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname"              # Standard libraries
+# end
+target :lib do
+  check 'lib'
+  signature 'sig'
+end

data/lib/copy_tuner_incompatible_search/command.rb

@@ -15,8 +15,8 @@ module CopyTunerIncompatibleSearch
       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)
+      ignored_keys = search_ignored_keys
+      XlsxWriter.new(results, incompatible_keys, ignored_keys).save_to(output_path)
       puts 'Finish'
     end
 
@@ -46,14 +46,33 @@ module CopyTunerIncompatibleSearch
       def add_usage(grep_result)
         grep_result.each_line do |line|
           if lazy?
-            line.scan(/['"](\.[^'"]+)/).flatten.each do |lazy_key|
-              @usages << Usage.new(line, lazy_key)
+            line.scan(/(?<=['"])\.[^'"]+/) do |lazy_key|
+              @usages << Usage.new(line, lazy_key.to_s)
             end
           else
             @usages << Usage.new(line)
           end
         end
       end
+
+      def full_key_for(usage)
+        if lazy?
+          path = usage
+                 .file
+                 .sub(%r{^app/views/}, '')
+                 .sub(/\..+$/, '')
+                 .sub('/_', '/')
+                 .gsub('/', '.')
+          path + usage.lazy_key.to_s
+        else
+          key
+        end
+      end
+
+      def already_migrated?(usage)
+        used_key = lazy? ? usage.lazy_key : key
+        usage.initializers? || usage.code.include?("#{used_key}_html")
+      end
     end
 
     class Usage
@@ -63,31 +82,31 @@ module CopyTunerIncompatibleSearch
         file, line, code = grep_result.split(':', 3)
         @file = file
         @line = line
-        @code = code.strip
+        @code = code.to_s.strip
         @lazy_key = lazy_key
       end
+
+      def initializers?
+        file == 'config/initializers/copy_tuner.rb'
+      end
     end
 
     def search_incompatible_keys
       stdout = detect_html_incompatible_keys
       keys = stdout.lines(chomp: true).map do |line|
-        line.split('.', 2).last
+        line.split('.', 2).last.to_s
       end.uniq.sort
       Set[*keys]
     end
 
     def search_static_usages(incompatible_keys)
       puts "Searching #{incompatible_keys.count} keys"
-      count = 0
-      incompatible_keys.map do |key|
-        count += 1
+      incompatible_keys.map.with_index(1) do |key, count|
         puts "#{count} / #{incompatible_keys.count}" if (count % 100).zero?
 
         result = Result.new(:static, key)
         usage = grep_usage(key).strip
-        unless usage.empty?
-          result.add_usage(usage)
-        end
+        result.add_usage(usage)
         result
       end
     end
@@ -106,6 +125,10 @@ module CopyTunerIncompatibleSearch
       result
     end
 
+    def search_ignored_keys
+      Set[*eval(ignored_keys_text)] # rubocop:disable Security/Eval
+    end
+
     def detect_html_incompatible_keys
       `rails copy_tuner:detect_html_incompatible_keys`
     end

data/lib/copy_tuner_incompatible_search/version.rb

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

data/lib/copy_tuner_incompatible_search/xlsx_writer.rb

@@ -2,17 +2,13 @@
 
 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)
+    def save_to(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)
@@ -45,30 +41,22 @@ module CopyTunerIncompatibleSearch
     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)
+        unless result.dynamic?
+          full_key = result.full_key_for(usage)
+          next unless should_output?(usage, result, full_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
+          ignored = ignored_flag(full_key)
+        end
+        sheet.add_row [result.type, full_key, ignored.to_s, usage.file, usage.line, usage.code], style: style
         added = true
       end
-      if !added && result.static?
+      if result.static? && !added
         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
+    def should_output?(usage, result, full_key)
+      incompatible_keys.include?(full_key) && !result.already_migrated?(usage)
     end
 
     def ignored_flag(key)

data/sig/lib/copy_tuner_incompatible_search/command.rbs

@@ -0,0 +1,67 @@
+module CopyTunerIncompatibleSearch
+  class Command
+    def self.run: (String output_path) -> void
+
+    def run: (String output_path) -> void
+
+    private
+
+    class Result
+      type result_type = :dynamic | :static | :lazy
+
+      attr_reader type: result_type
+
+      attr_reader key: String
+
+      attr_reader usages: Array[Usage]
+
+      def initialize: (result_type type, String key) -> void
+
+      def static?: () -> bool
+
+      def lazy?: () -> bool
+
+      def dynamic?: () -> bool
+
+      def add_usage: (String grep_result) -> void
+
+      def full_key_for: (Usage usage) -> String
+
+      def already_migrated?: (Usage usage) -> bool
+    end
+
+    class Usage
+      attr_reader file: String
+
+      attr_reader line: String
+
+      attr_reader code: String
+
+      attr_reader lazy_key: String?
+
+      def initialize: (String grep_result, ?String? lazy_key) -> void
+
+      def initializers?: () -> bool
+    end
+
+    def search_incompatible_keys: () -> Set[String]
+
+    def search_static_usages: (Set[String] incompatible_keys) -> Array[Result]
+
+    def search_lazy_usages: () -> Result
+
+    def search_dynamic_usages: () -> Result
+
+    def search_ignored_keys: () -> Set[String]
+
+    def detect_html_incompatible_keys: () -> String
+
+    def grep_lazy_keys: () -> String
+
+    def grep_dynamic_keys: () -> String
+
+    def grep_usage: (String key) -> String
+
+    def ignored_keys_text: () -> ::String
+  end
+end

data/sig/lib/copy_tuner_incompatible_search/xlsx_writer.rbs

@@ -0,0 +1,29 @@
+module CopyTunerIncompatibleSearch
+  class XlsxWriter
+    def initialize: (Array[Command::Result] results, Set[String] incompatible_keys, Set[String] ignored_keys) -> void
+
+    def save_to: (String output_path) -> void
+
+    private
+
+    attr_reader results: Array[Command::Result]
+
+    attr_reader incompatible_keys: Set[String]
+
+    attr_reader ignored_keys: Set[String]
+
+    def freeze_pane: (untyped sheet) -> void
+
+    def add_result_rows: (untyped sheet, Command::Result result, untyped style) -> void
+
+    def should_output?: (Command::Usage usage, Command::Result result, String full_key) -> bool
+
+    def ignored_flag: (String key) -> ("Y" | "N")
+  end
+end
+
+module Axlsx
+  class Package
+    def initialize: () { (untyped) -> void }  -> void
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_incompatible_search
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Junichi Ito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx
@@ -39,12 +39,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - exe/copy_tuner_incompatible_search
 - 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
+- sig/lib/copy_tuner_incompatible_search/command.rbs
+- sig/lib/copy_tuner_incompatible_search/xlsx_writer.rbs
 homepage: https://github.com/JunichiIto/copy_tuner_incompatible_search
 licenses:
 - MIT