bulletmark_repairer 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eabc96bcf1961f834090322c3b9a62173139f806513c5ec99d452f18a661c71
-  data.tar.gz: b55ab6f5adade690b6cb34ef92fc752bdfa697a3b8d7779d54150aaf4e1083bb
+  metadata.gz: 39af4a769d591a28ab628d174b6224984bf3f87460e2ee4d782a5a16a3c04d87
+  data.tar.gz: 2b163d905540357085ef7d9436abc189d4cde357f95a5e7650b538b195bb95bc
 SHA512:
-  metadata.gz: 714da7b74b7015194f965c83c1260d31b8a4f75b4f7a24b3038eac6c81ced4aa8a77a79abbe5a684a347093fbb00d0e9f1b05682729b96afe64ed2a83b110534
-  data.tar.gz: e48064688caaa2003d30192bfd2a76ff677fdcb4b4bb02bb8b828fece22b9fd5dab69a47aef2fb836a69e9f5b16db10d2c1faefcb9e249ba5b8a3df671310c03
+  metadata.gz: c5a8331d8787887ff29e736d353978d6d86000d14713df1576f131c9a661aaf166421aa963bd4752a5d3d55f2ee642fdbfeac3e551defe126450cd6d4c5d1aa3
+  data.tar.gz: 9d9a6aa80d778ec59b86d4eea3123e732ab146b01dfaf46ef78a7d66ebb0e1923558a903eef36afd895fb97404b4650585ad7ee3b5cbc34e16b947d790952f7b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.1.7] - 2023-11-21
+
+- Validate detected instance_variable is an ActiveRecord::Relation [ed650ae](https://github.com/makicamel/bulletmark_repairer/commit/ed650ae41b4389774cb1135031f077e953d2c5db) [86497bd](https://github.com/makicamel/bulletmark_repairer/commit/86497bd3cbb6daf1672cd18210e5842d0ecc084f)
+- Add includes after methods returning AR on autocorrect [767e5e1](https://github.com/makicamel/bulletmark_repairer/commit/767e5e1389f84daa6efce4463a4979a100c16640)
+
 ## [0.1.6] - 2023-11-09
 
 Fix a bug when N+1 is caused not in the request (e.g. Sidekiq) [51f051e](https://github.com/makicamel/bulletmark_repairer/commit/51f051e608b84b7da96ac879a324ed438c14eeeb)

data/lib/bulletmark_repairer/controller_corrector.rb

@@ -33,6 +33,14 @@ class ControllerCorrector < Parser::TreeRewriter
     @patched ||= false
   end
 
+  def includes_token
+    @includes_token ||= ".includes(#{associations})"
+  end
+
+  def inserted?(parent_node)
+    parent_node.location.expression.source.include?(includes_token)
+  end
+
   def target_nodes
     @target_nodes ||= {}
   end
@@ -47,10 +55,8 @@ class ControllerCorrector < Parser::TreeRewriter
 
     type, identifier = node.to_sexp_array.take(2)
     if type == :ivasgn && identifier == instance_variable_name
-      inserted = ".includes(#{associations})"
-      unless node.location.expression.source.include?(inserted)
-        insert_after node.children.last.location.expression, inserted
-        @patched = true
+      node.children.each do |child_node|
+        execute_insert_includes(node: child_node, parent_node: node)
       end
     else
       node
@@ -67,6 +73,22 @@ class ControllerCorrector < Parser::TreeRewriter
     end
   end
 
+  def execute_insert_includes(node:, parent_node:)
+    return unless node.respond_to?(:children)
+    return if patched?
+
+    node.children.each do |child_node|
+      if child_node.is_a?(Symbol)
+        if BulletmarkRepairer::Thread.correctable_method?(child_node) && !inserted?(parent_node)
+          insert_after node.location.expression, includes_token
+          @patched = true
+        end
+      else
+        execute_insert_includes(node: child_node, parent_node: node)
+      end
+    end
+  end
+
   def action
     :__EMBEDDED_ACTION__
   end

data/lib/bulletmark_repairer/markers.rb

@@ -82,7 +82,6 @@ module BulletmarkRepairer
         end
         view_file, view_yield_index = @stacktraces[view_file_index].scan(%r{\A(/[./\w]+):(\d+):in `[\w]+'\z}).flatten
         view_yield_index = view_yield_index.to_i
-        # TODO: Compile views
         File.open(view_file) do |f|
           lines = f.readlines
           loop do
@@ -90,7 +89,8 @@ module BulletmarkRepairer
 
             view_yield_index -= 1
             line = lines[view_yield_index]
-            @instance_variable_name = line&.scan(/\b?(@[\w]+)\b?/)&.flatten&.last
+            token = line&.scan(/\b?(@[\w]+)\b?/)&.flatten&.last
+            @instance_variable_name = token if BulletmarkRepairer::Thread.instance_variable_name?(token)
           end
         end
         @index = @instance_variable_name ? "#{view_file}:#{view_yield_index}" : nil

data/lib/bulletmark_repairer/monkey_patches/action_view/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  module ActionView
+    module Base
+      def initialize(*args)
+        super(*args)
+        @_assigns.each do |ivname, value|
+          BulletmarkRepairer::Thread.memorize_instance_variable_name(name: ivname, value: value)
+        end
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/monkey_patches/active_record/query_method.rb

@@ -4,17 +4,17 @@ module BulletmarkRepairer
   module ActiveRecord
     module QueryMethod
       def includes(*args)
-        BulletmarkRepairer::Thread.add(name: model.name, method_type: :includes, args: args)
+        BulletmarkRepairer::Thread.memorize_associations(name: model.name, method_type: :includes, args: args)
         super(args)
       end
 
       def eager_load(*args)
-        BulletmarkRepairer::Thread.add(name: model.name, method_type: :eager_load, args: args)
+        BulletmarkRepairer::Thread.memorize_associations(name: model.name, method_type: :eager_load, args: args)
         super(args)
       end
 
       def preload(*args)
-        BulletmarkRepairer::Thread.add(name: model.name, method_type: :preload, args: args)
+        BulletmarkRepairer::Thread.memorize_associations(name: model.name, method_type: :preload, args: args)
         super(args)
       end
     end

data/lib/bulletmark_repairer/rack.rb

@@ -7,15 +7,22 @@ module BulletmarkRepairer
     end
 
     def call(env)
+      trace_point = TracePoint.trace(:return) do |tp|
+        BulletmarkRepairer::Thread.memorize_methods(
+          method_name: tp.method_id,
+          value: tp.return_value
+        )
+      end
       @app.call(env)
     ensure
+      trace_point.disable
       begin
         if ::Thread.current[:bullet_notification_collector].notifications_present?
           BulletmarkRepairer::Patcher.execute(
             notifications: ::Thread.current[:bullet_notification_collector],
             controller: env['action_dispatch.request.parameters']['controller'],
             action: env['action_dispatch.request.parameters']['action'],
-            loaded_associations: BulletmarkRepairer::Thread.current
+            loaded_associations: BulletmarkRepairer::Thread.current(:loaded_associations)
           )
         end
       rescue StandardError => e

data/lib/bulletmark_repairer/railtie.rb

@@ -14,5 +14,9 @@ module BulletmarkRepairer
       require 'bulletmark_repairer/monkey_patches/active_record/query_method'
       ::ActiveRecord::Relation.prepend(BulletmarkRepairer::ActiveRecord::QueryMethod)
     end
+    ActiveSupport.on_load(:action_view) do
+      require 'bulletmark_repairer/monkey_patches/action_view/base'
+      ::ActionView::Base.prepend(BulletmarkRepairer::ActionView::Base)
+    end
   end
 end

data/lib/bulletmark_repairer/retry_corrector.rb

@@ -13,6 +13,14 @@ class RetryCorrector < Parser::TreeRewriter
     @patched ||= false
   end
 
+  def includes_token
+    @includes_token ||= ".includes(#{associations})"
+  end
+
+  def inserted?(parent_node)
+    parent_node.location.expression.source.include?(includes_token)
+  end
+
   def insert_includes(node:)
     return if patched?
     return if !node.respond_to?(:children) || node.children.empty?
@@ -21,11 +29,25 @@ class RetryCorrector < Parser::TreeRewriter
     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)
+      node.children.each do |child_node|
+        execute_insert_includes(node: child_node, parent_node: node)
+      end
+    end
+  end
+
+  def execute_insert_includes(node:, parent_node:)
+    return unless node.respond_to?(:children)
+    return if patched?
 
-      insert_after node.location.expression, ".includes(#{associations})"
-      @patched = true
+    node.children.each do |child_node|
+      if child_node.is_a?(Symbol)
+        if BulletmarkRepairer::Thread.correctable_method?(child_node) && !inserted?(parent_node)
+          insert_after node.location.expression, includes_token
+          @patched = true
+        end
+      else
+        execute_insert_includes(node: child_node, parent_node: node)
+      end
     end
   end
 

data/lib/bulletmark_repairer/thread.rb

@@ -5,24 +5,52 @@ require 'rails'
 module BulletmarkRepairer
   class Thread
     class << self
-      def current
-        touch
+      def current(key)
+        touch(key)
       end
 
-      def add(name:, method_type:, args:)
-        touch
-        ::Thread.current[:bulletmark_repaier_loaded_associations][name][method_type].add(args)
+      def memorize_associations(name:, method_type:, args:)
+        current(:loaded_associations)[name][method_type].add(args)
+      end
+
+      def memorize_instance_variable_name(name:, value:)
+        return unless value.is_a?(::ActiveRecord::Relation)
+
+        current(:loaded_instance_variables).add("@#{name}")
+      end
+
+      def instance_variable_name?(name)
+        current(:loaded_instance_variables).include?(name)
+      end
+
+      # TODO: Memorize methods with class
+      def memorize_methods(method_name:, value:)
+        return unless value.is_a?(::ActiveRecord::Associations::CollectionProxy) || value.is_a?(::ActiveRecord::Relation)
+
+        current(:loaded_methods).add(method_name)
+      end
+
+      def correctable_method?(method_name)
+        current(:loaded_methods).include?(method_name)
       end
 
       def clear
-        ::Thread.current[:bulletmark_repaier_loaded_associations] = nil
+        ::Thread.current[:bulletmark_repairer] = nil
       end
 
       private
 
-      def touch
-        ::Thread.current[:bulletmark_repaier_loaded_associations] ||= Hash.new do |hash, key|
-          hash[key] = { includes: Set.new, eager_load: Set.new, preload: Set.new }
+      def touch(key)
+        ::Thread.current[:bulletmark_repairer] ||= {}
+        case key
+        when :loaded_associations
+          ::Thread.current[:bulletmark_repairer][:loaded_associations] ||= Hash.new do |hash, key|
+            hash[key] = { includes: Set.new, eager_load: Set.new, preload: Set.new }
+          end
+        when :loaded_instance_variables
+          ::Thread.current[:bulletmark_repairer][:loaded_instance_variables] ||= Set.new
+        when :loaded_methods
+          ::Thread.current[:bulletmark_repairer][:loaded_methods] ||= Set.new
         end
       end
     end

data/lib/bulletmark_repairer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulletmark_repairer
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -90,6 +90,7 @@ files:
 - lib/bulletmark_repairer/corrector_builder.rb
 - lib/bulletmark_repairer/loaded_associations.rb
 - lib/bulletmark_repairer/markers.rb
+- lib/bulletmark_repairer/monkey_patches/action_view/base.rb
 - lib/bulletmark_repairer/monkey_patches/active_record/query_method.rb
 - lib/bulletmark_repairer/patcher.rb
 - lib/bulletmark_repairer/rack.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Auto corrector for N+1 queries detected at runtime with Bullet