bulletmark_repairer 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7110364b32065ccdce57c9220481a6c3ab36265a1fbc1fcb0d40a5d6a92ceeb
-  data.tar.gz: e69d9ae29d6a2f0e013e8d974ac5634e98750c31cf57eacbbbee1ed48778f5ce
+  metadata.gz: 3d44edbc5a6deb0c95e4e1ed79c2f2b1c7b283ff54e3f00d33bbf9a8b70f698e
+  data.tar.gz: 5d3ba75ca53cd5e721f971894fc2f1001e1fd391f4daf44a53184ef861cb532b
 SHA512:
-  metadata.gz: 4eb6a1e8d2274100f04d72f544c0dce8588b758216bfbe08968947fc535d7fe3e0fba8f7d722600737c18e52cbe468e0ed2482e48e9d9372ca18c3f66e1c05fa
-  data.tar.gz: fe6a169678171236abebdff07cf2adfef7af32066c07656ad327fbb33d692a0b9171c5b418932c653ae4a8c0eb95be823c8d29d2f17423f7fe7d8be663fd5aa2
+  metadata.gz: 617f5750639fe286efd6fa7d0d7bb40d0be0d258ef94600717ad98f2f46c6bfad966ea651bd5b0113f3ab9b0ff4d5749a5316bc7cca7c83c7dabc781d890ac20
+  data.tar.gz: e6698f869f1c1f50b08332c6ec3134cfd32716325c5b2607e4a7247cf5bf807ed5f39f633822288d641246167b82e1f6b6e969d24b7cde322764204823fbea24

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.1.5] - 2023-10-27
+
+Be able to patch for nested associations require `includes` though child associations are already included [d1b7445](https://github.com/makicamel/bulletmark_repairer/commit/d1b7445556c20bc037beb6a013ac70531426a7ea)
+
+## [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])

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
+  # Multiple nested associations require `includes` though child associations are already included
+  @plays = Play.includes(:actors)
+  # expected correct
+  @plays = Play.includes(:actors).includes({:actors=>{:company=>[:offices]}})
+  # actual correct
+  @plays = Play.includes(:actors).includes({:actors=>[:company]})
 end
 ```
 

data/lib/bulletmark_repairer/associations_builder.rb

@@ -10,7 +10,11 @@ module BulletmarkRepairer
       if associations[marker.index]
         associations[marker.index].add(marker)
       else
-        associations[marker.index] = Associations.new(marker, @application_associations)
+        associations[marker.index] = Associations.new(
+          marker,
+          @application_associations,
+          @loaded_associations
+        )
       end
     end
 
@@ -20,8 +24,9 @@ module BulletmarkRepairer
 
     private
 
-    def initialize
+    def initialize(loaded_associations)
       @application_associations = BulletmarkRepairer::ApplicationAssociations.new
+      @loaded_associations = BulletmarkRepairer::LoadedAssociations.new(loaded_associations)
     end
   end
 
@@ -44,10 +49,12 @@ module BulletmarkRepairer
 
     private
 
-    def initialize(marker, application_associations)
+    def initialize(marker, application_associations, loaded_associations)
       @marker = marker
-      @associations = { base: marker.associations }
       @application_associations = application_associations
+      @loaded_associations = loaded_associations
+      key = @loaded_associations.key(marker.base_class)
+      @associations = { base: key ? { key => marker.associations } : marker.associations }
     end
 
     # @return [Hash, nil]

data/lib/bulletmark_repairer/controller_corrector.rb

@@ -55,7 +55,6 @@ class ControllerCorrector < Parser::TreeRewriter
     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/loaded_associations.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  class LoadedAssociations
+    attr_reader :associations
+
+    def key(target_klass_name)
+      key = target_klass_name.underscore
+
+      result = []
+      @associations.each do |_base_klass_name, all_associations|
+        all_associations.each do |_key, associations|
+          # TODO: reccurent check
+          associations.each do |values|
+            values.flatten.each do |value|
+              result.append search_key(key, value)
+            end
+          end
+        end
+      end
+      result = result.flatten.compact.uniq.presence
+      build_keys(result)
+    end
+
+    private
+
+    def search_key(key, value)
+      case value
+      when Hash
+        search_key(key, value.keys) || search_key(key, value.values)
+      when Array
+        value.map { |v| search_key(key, v) }
+      else
+        if key.pluralize.to_sym == value
+          key.pluralize.to_sym
+        elsif key.singularize.to_sym == value
+          key.singularize.to_sym
+        end
+      end
+    end
+
+    def build_keys(keys)
+      return unless keys
+
+      if keys.size == 1
+        keys.first
+      else
+        { keys.first => keys.last }
+      end
+    end
+
+    def initialize(original_associations)
+      @associations = Hash.new { |h, k| h[k] = {} }
+      original_associations.each do |base_class, all_associations|
+        all_associations.each do |key, associations|
+          @associations[base_class][key] = associations.to_a
+        end
+      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/monkey_patches/active_record/query_method.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  module ActiveRecord
+    module QueryMethod
+      def includes(*args)
+        Thread.current[:bulletmark_repaier_loaded_associations][model.name][:includes].add(args)
+        super(args)
+      end
+
+      def eager_load(*args)
+        Thread.current[:bulletmark_repaier_loaded_associations][model.name][:eager_load].add(args)
+        super(args)
+      end
+
+      def preload(*args)
+        Thread.current[:bulletmark_repaier_loaded_associations][model.name][:preload].add(args)
+        super(args)
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/patcher.rb

@@ -6,8 +6,8 @@ require 'parser/runner/ruby_rewrite'
 
 module BulletmarkRepairer
   class Patcher
-    def self.execute(notifications:, controller:, action:)
-      new(notifications: notifications, controller: controller, action: action).execute
+    def self.execute(notifications:, controller:, action:, loaded_associations:)
+      new(notifications: notifications, controller: controller, action: action, loaded_associations: loaded_associations).execute
     end
 
     def execute
@@ -24,9 +24,9 @@ module BulletmarkRepairer
 
     private
 
-    def initialize(notifications:, controller:, action:)
+    def initialize(notifications:, controller:, action:, loaded_associations:)
       @markers = Markers.new(notifications, controller: controller, action: action)
-      @associations_builder = BulletmarkRepairer::AssociationsBuilder.new
+      @associations_builder = BulletmarkRepairer::AssociationsBuilder.new(loaded_associations)
     end
   end
 end

data/lib/bulletmark_repairer/rack.rb

@@ -7,6 +7,9 @@ module BulletmarkRepairer
     end
 
     def call(env)
+      Thread.current[:bulletmark_repaier_loaded_associations] = Hash.new do |hash, key|
+        hash[key] = { includes: Set.new, eager_load: Set.new, preload: Set.new }
+      end
       @app.call(env)
     ensure
       begin
@@ -14,12 +17,14 @@ module BulletmarkRepairer
           BulletmarkRepairer::Patcher.execute(
             notifications: Thread.current[:bullet_notification_collector],
             controller: env['action_dispatch.request.parameters']['controller'],
-            action: env['action_dispatch.request.parameters']['action']
+            action: env['action_dispatch.request.parameters']['action'],
+            loaded_associations: Thread.current[:bulletmark_repaier_loaded_associations]
           )
         end
       rescue StandardError => e
         raise e if BulletmarkRepairer.config.debug?
       end
+      Thread.current[:bulletmark_repaier_loaded_associations].clear
     end
   end
 end

data/lib/bulletmark_repairer/railtie.rb

@@ -9,5 +9,10 @@ module BulletmarkRepairer
       require 'bulletmark_repairer/rack'
       app.middleware.insert_after Bullet::Rack, BulletmarkRepairer::Rack
     end
+
+    ActiveSupport.on_load(:active_record) do
+      require 'bulletmark_repairer/monkey_patches/active_record/query_method'
+      ::ActiveRecord::Relation.prepend(BulletmarkRepairer::ActiveRecord::QueryMethod)
+    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.3'
+  VERSION = '0.1.5'
 end

data/lib/bulletmark_repairer.rb

@@ -6,6 +6,7 @@ require 'bulletmark_repairer/application_associations'
 require 'bulletmark_repairer/associations_builder'
 require 'bulletmark_repairer/configuration'
 require 'bulletmark_repairer/corrector_builder'
+require 'bulletmark_repairer/loaded_associations'
 require 'bulletmark_repairer/markers'
 require 'bulletmark_repairer/patcher'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulletmark_repairer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -88,10 +88,13 @@ files:
 - lib/bulletmark_repairer/configuration.rb
 - lib/bulletmark_repairer/controller_corrector.rb
 - lib/bulletmark_repairer/corrector_builder.rb
+- lib/bulletmark_repairer/loaded_associations.rb
 - lib/bulletmark_repairer/markers.rb
+- lib/bulletmark_repairer/monkey_patches/active_record/query_method.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