Output log when fail to find the target file

makicamel · Oct 9, 2023 · 02fd6d5 · 02fd6d5
1 parent 4477c8c
commit 02fd6d5
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/lib/bulletmark_repairer/associations_builder.rb b/lib/bulletmark_repairer/associations_builder.rb
@@ -5,7 +5,6 @@
 module BulletmarkRepairer
   class AssociationsBuilder
     def build(marker)
-      # TODO: Notify if fail to find suitable file to be patched
       return if marker.skip?
 
       if associations[marker.index]

diff --git a/lib/bulletmark_repairer/configuration.rb b/lib/bulletmark_repairer/configuration.rb
@@ -2,12 +2,13 @@
 
 module BulletmarkRepairer
   class Configration
-    attr_accessor :skip_file_list
+    attr_accessor :skip_file_list, :logger
     attr_writer :development
 
     def initialize
       @development = false
       @skip_file_list = []
+      @logger = Logger.new("#{Rails.root}/log/bulletmark_repairer.log")
     end
 
     def development?

diff --git a/lib/bulletmark_repairer/markers.rb b/lib/bulletmark_repairer/markers.rb
@@ -44,6 +44,7 @@ def add_association(notification)
     end
 
     def skip?
+      log_patchable_files_not_be_found
       index.nil? || file_name.remove("#{Rails.root}/").in?(BulletmarkRepairer.config.skip_file_list)
     end
 
@@ -53,6 +54,20 @@ def n_plus_one_in_view?
 
     private
 
+    def log_patchable_files_not_be_found
+      return if index
+
+      BulletmarkRepairer.config.logger.info <<~LOG
+        Repairer couldn't patch
+        #{"#{@controller}_controller".camelize.constantize}##{@action}
+        #{base_class} => #{associations}
+        Might be able to add one of the following
+          includes(#{associations}) / includes(#{base_class.underscore}: #{associations}) / includes(#{base_class.underscore.pluralize}: #{associations})
+        Stacktraces
+          #{@stacktraces.join("\n  ")}
+      LOG
+    end
+
     def set_up
       @n_plus_one_in_view = @stacktraces.any? { |stacktrace| stacktrace.match?(%r{\A#{Rails.root}/app/views/[./\w]+:\d+:in `[\w]+'\z}) }