bulletmark_repairer 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533eed3a74c78c89236e5c1355f588814c6a4017cf79af12f0a0e23fe030fcde
-  data.tar.gz: bf8a718e822ba241ab3299f675db3809870d955257bc5279644285373a619141
+  metadata.gz: 4b793a019d2937170c113a1b95eeea035a23e0f85a36f5c86382628467d3b006
+  data.tar.gz: 0e513ae03aab2b2f21785d31be5141abe0a34759a16a97e41b32871caf01d531
 SHA512:
-  metadata.gz: a33cc9ba73a76ebca97b8293677d8498761a07c2a6680e5182a65b2d8f7cb6237196506aedee63ed4f798168beb4161072ee5e62cbcee9506c4040e4584a508f
-  data.tar.gz: 2fb1af553ee13ca638023120306f6284b4d04ae567171616cee658ee5277f1bb33a589d769d7625ad0d6b445d06664a068dc49db479e8ac91934d36aef3553d6
+  metadata.gz: bb0869546bfe5bd2c29586cffc2261f58680bb114a7f5dd01c0d4325df6736d49e24e743200285eb5cf199b87123e22bfe85cb8dce0eb2546d469e71fd98afd9
+  data.tar.gz: 2ef8b880ef7e027b3a49a08638235a342ad8e8f1c7a35485f01f3c3cbbbb09b8cd4b75ec21b7522a2439e685833b05ed9488d3a75c916df8391453ea618f7aa8

data/.rubocop.yml

@@ -31,3 +31,6 @@ Metrics/BlockLength:
 
 Style/Documentation:
   Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,17 @@
+## [0.1.4] - 2023-10-22
+
+- Patch files other than controllers [218566d](https://github.com/makicamel/bulletmark_repairer/commit/218566d1531751f204941c3dcff7f095a056d39f)
+- Patch unassigned queries [159573a](https://github.com/makicamel/bulletmark_repairer/commit/159573ada036ee3ee39428b1e59066934b676c02)
+- Apply patches starting from the top of the method [f8d0058](https://github.com/makicamel/bulletmark_repairer/commit/f8d00582a5b3b084c0a35a54726396a2a063f8dd)
+- Log also when the target file is in the skip list [a23a3bc](https://github.com/makicamel/bulletmark_repairer/commit/a23a3bc0edf1e94d3aa6ea95449c9570b9322d65)
+
+## [0.1.3] - 2023-10-18
+
+- Fix a redundant auto-correct for multiple tests with n+1 queries when running RSpec [#6](https://github.com/makicamel/bulletmark_repairer/pull/6) ([@ydah])
+
 ## [0.1.2] - 2023-10-16
 
-- Reduce dependencies [#1](https://github.com/makicamel/bulletmark_repairer/pull/1) [@tricknotes]()
+- Reduce dependencies [#1](https://github.com/makicamel/bulletmark_repairer/pull/1) ([@tricknotes])
 - Stop using class instance variables for thread safe [024f6c5](https://github.com/makicamel/bulletmark_repairer/commit/024f6c53f82b182a998c1e43de48d8c6c9ce5bf3)
 
 ## [0.1.1] - 2023-10-11
@@ -10,3 +21,6 @@
 ## [0.1.0] - 2023-10-10
 
 - Initial release
+
+[@tricknotes]: https://github.com/tricknotes
+[@ydah]: https://github.com/ydah

data/README.md

@@ -47,14 +47,12 @@ For example, the following cases are not supported as known cases currently:
 
 ```ruby
 def index
-  # N+1 is caused but not assigned
-  Play.all_actors_name
-end
-
-def index
-  # N+1 occurs when assigning a local variable
-  plays = Play.all.as_json
-  @play = plays.last
+  # Nested associations require `includes` though child associations are already included
+  @plays = Play.includes(:actors)
+  # expected correct
+  @plays = Play.includes(actors: [:company])
+  # actual correct
+  @plays = Play.includes(:actors).includes([:company])
 end
 ```
 

data/lib/bulletmark_repairer/configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BulletmarkRepairer
-  class Configration
+  class Configuration
     attr_accessor :skip_file_list, :logger
     attr_writer :debug
 
@@ -22,7 +22,7 @@ module BulletmarkRepairer
     end
 
     def config
-      @config ||= Configration.new
+      @config ||= Configuration.new
     end
   end
 end

data/lib/bulletmark_repairer/controller_corrector.rb

@@ -46,14 +46,15 @@ class ControllerCorrector < Parser::TreeRewriter
     return unless node.respond_to?(:to_sexp_array)
 
     type, identifier = node.to_sexp_array.take(2)
-
     if type == :ivasgn && identifier == instance_variable_name
-      insert_after node.children.last.location.expression, ".includes(#{associations})"
-      @patched = true
+      inserted = ".includes(#{associations})"
+      unless node.location.expression.source.include?(inserted)
+        insert_after node.children.last.location.expression, inserted
+        @patched = true
+      end
     else
       node
         .children
-        .reverse
         .each do |child_node|
           child_type, _, child_identifier = child_node.try(:to_sexp_array)
           if child_type == :send && target_nodes.key?(child_identifier)

data/lib/bulletmark_repairer/corrector_builder.rb

@@ -16,17 +16,30 @@ module BulletmarkRepairer
     end
 
     def execute
-      corrector_name = '/controller_corrector.rb'
-      File.open("#{@dir}#{corrector_name}", 'w') do |f|
-        corrector = Pathname.new(__FILE__).sub('/corrector_builder.rb', corrector_name)
-        src = File.read(corrector)
-        src
-          .sub!(ASSOCIATIONS, @associations[:base].to_s)
-          .sub!(ACTION, @action)
-          .sub!(INSTANCE_VARIABLE_NAME, @instance_variable_name)
-        f.puts src
-        f
-      end.path
+      if @marker.retry
+        corrector_name = '/retry_corrector.rb'
+        File.open("#{@dir}#{corrector_name}", 'w') do |f|
+          corrector = Pathname.new(__FILE__).sub('/corrector_builder.rb', corrector_name)
+          src = File.read(corrector)
+          src
+            .sub!(ASSOCIATIONS, @associations[:base].to_s)
+            .sub!(LINE_NO, @marker.line_no)
+          f.puts src
+          f
+        end.path
+      else
+        corrector_name = '/controller_corrector.rb'
+        File.open("#{@dir}#{corrector_name}", 'w') do |f|
+          corrector = Pathname.new(__FILE__).sub('/corrector_builder.rb', corrector_name)
+          src = File.read(corrector)
+          src
+            .sub!(ASSOCIATIONS, @associations[:base].to_s)
+            .sub!(ACTION, @action)
+            .sub!(INSTANCE_VARIABLE_NAME, @instance_variable_name)
+          f.puts src
+          f
+        end.path
+      end
     end
   end
 end

data/lib/bulletmark_repairer/markers.rb

@@ -28,7 +28,7 @@ module BulletmarkRepairer
   end
 
   class Marker
-    attr_reader :base_class, :associations, :action, :file_name, :instance_variable_name, :index
+    attr_reader :base_class, :associations, :action, :file_name, :instance_variable_name, :index, :retry, :line_no
 
     def initialize(notification, controller:, action:)
       @base_class = notification.instance_variable_get(:@base_class)
@@ -36,6 +36,8 @@ module BulletmarkRepairer
       @associations = notification.instance_variable_get(:@associations)
       @controller = controller
       @action = action
+      @retry = false
+      @line_no = nil
       set_up
     end
 
@@ -56,6 +58,7 @@ module BulletmarkRepairer
 
     def log_patchable_files_not_be_found
       return if index
+      return if BulletmarkRepairer.config.skip_file_list.exclude?(file_name.remove("#{Rails.root}/"))
 
       BulletmarkRepairer.config.logger.info <<~LOG
         Repairer couldn't patch
@@ -93,7 +96,6 @@ module BulletmarkRepairer
         @index = @instance_variable_name ? "#{view_file}:#{view_yield_index}" : nil
       else
         # TODO: Ignore controllers list
-        # TODO: Allow directories list
         controller_file_index = @stacktraces.index { |stacktrace| stacktrace.match?(%r{\A(#{Rails.root}/app/controllers[./\w]+):(\d+):in `[()\w\s]+'\z}) }
         @file_name, controller_yield_index = @stacktraces[controller_file_index].scan(%r{\A(#{Rails.root}/app/controllers[./\w]+):(\d+):in `[()\w\s]+'\z}).flatten
         controller_yield_index = controller_yield_index.to_i
@@ -104,13 +106,25 @@ module BulletmarkRepairer
 
             controller_yield_index -= 1
             line = lines[controller_yield_index]
-            # TODO: patch to local variables
             @instance_variable_name = line&.scan(/\b?(@[\w]+)\b?/)&.flatten&.last
             break if line.match?(/^\s+def [()\w\s=]+$/)
           end
         end
         @index = @instance_variable_name ? "#{@file_name}:#{controller_yield_index}" : nil
       end
+
+      return if @index
+
+      # TODO: Ignore files list
+      # TODO: Allow model files list
+      @retry = @stacktraces.any? do |stacktrace|
+                 !stacktrace.match?(%r{\A(#{Rails.root}/app/models[./\w]+):(\d+):in `[()\w\s=!?]+'\z}) &&
+                   stacktrace =~ %r{\A(#{Rails.root}/app[./\w]+):(\d+):in `[()\w\s=!?]+'\z}
+               end.tap do
+        @file_name = Regexp.last_match(1)
+        @line_no = Regexp.last_match(2)
+      end
+      @index = @retry ? "#{@file_name}:#{@line_no}" : nil
     end
   end
 end

data/lib/bulletmark_repairer/retry_corrector.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class RetryCorrector < Parser::TreeRewriter
+  def on_def(node)
+    return if patched?
+
+    node.children.each { |child_node| insert_includes(node: child_node) }
+  end
+
+  private
+
+  def patched?
+    @patched ||= false
+  end
+
+  def insert_includes(node:)
+    return if patched?
+    return if !node.respond_to?(:children) || node.children.empty?
+    return unless node.location.expression.line <= line_no && line_no <= node.location.expression.last_line
+
+    if node.type == :begin
+      node.children.each { |child_node| insert_includes(node: child_node) }
+    else
+      inserted = ".includes(#{associations})"
+      return if node.location.expression.source.include?(inserted)
+
+      insert_after node.location.expression, ".includes(#{associations})"
+      @patched = true
+    end
+  end
+
+  def line_no
+    __EMBEDDED_LINE_NO__
+  end
+
+  def associations
+    '__EMBEDDED_ASSOCIATIONS__'
+  end
+end

data/lib/bulletmark_repairer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulletmark_repairer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codespellignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -86,12 +87,12 @@ files:
 - lib/bulletmark_repairer/associations_builder.rb
 - lib/bulletmark_repairer/configuration.rb
 - lib/bulletmark_repairer/controller_corrector.rb
-- lib/bulletmark_repairer/corrector.rb
 - lib/bulletmark_repairer/corrector_builder.rb
 - lib/bulletmark_repairer/markers.rb
 - lib/bulletmark_repairer/patcher.rb
 - lib/bulletmark_repairer/rack.rb
 - lib/bulletmark_repairer/railtie.rb
+- lib/bulletmark_repairer/retry_corrector.rb
 - lib/bulletmark_repairer/version.rb
 - sig/bulletmark_repairer.rbs
 homepage: https://github.com/makicamel/bulletmark_repairer

data/lib/bulletmark_repairer/corrector.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-class Corrector < Parser::TreeRewriter
-  def on_def(node)
-    return if patched?
-
-    node.children.each { |child_node| insert_includes(node: child_node) }
-    return if patched?
-
-    node.children.each { |child_node| insert_includes_for_vasgn(node: child_node, type: :ivasgn) }
-    return if patched?
-
-    node.children.each { |child_node| insert_includes_for_vasgn(node: child_node, type: :lvasgn) }
-  end
-
-  private
-
-  def patched?
-    @patched ||= false
-  end
-
-  def insert_includes(node:)
-    return if patched?
-    return if !node.respond_to?(:children) || node.children.empty?
-    return unless node.location.expression.line <= line_no && line_no <= node.location.expression.last_line
-
-    # TODO: Patch Enumerable methods other than each and map
-    if node.children.last.in?(%i[each map])
-      insert_after node.children[0].location.expression, ".includes(#{associations})"
-      @patched = true
-    else
-      node.children.each { |child_node| insert_includes(node: child_node) }
-    end
-  end
-
-  def insert_includes_for_vasgn(node:, type:)
-    return if patched?
-    return if !node.respond_to?(:children) || node.children.empty?
-    return unless node.location.expression.line <= line_no && line_no <= node.location.expression.last_line
-
-    if node.type == type
-      insert_after node.children.last.location.expression, ".includes(#{associations})"
-      @patched = true
-    else
-      node.children.each { |child_node| insert_includes_for_vasgn(node: child_node, type: type) }
-    end
-  end
-
-  def line_no
-    __EMBEDDED_LINE_NO__
-  end
-
-  def associations
-    '__EMBEDDED_ASSOCIATIONS__'
-  end
-end