bulletmark_repairer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90214d67d25519f3e4b352583ad3631773d29444e28ce319d62c89d11fa0149e
+  data.tar.gz: 59bda8070c7e775774e6d52af33687f3a1da3e26889fe51a2ce71069fb211498
+SHA512:
+  metadata.gz: 2ad6acf09c537b4c283a9404c3518d43f176cc0078406b0371d44f1ea86222e041ddb1f19e9607df95948149f899cc5cda3584753899cc4a85f64232389c2beb
+  data.tar.gz: a2f5532b82a8f2d9a60d5a72b986d8c81d0d5709905226fb9a5ceac1ddebe1e325039e2870ecc020293b87ed36b10a4aa0ff97a1bd920f09a83e1c2f63268573

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2023-10-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at unright@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bulletmark_repairer.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'factory_bot_rails'
+gem 'rails'
+gem 'rspec', '~> 3.0'
+gem 'rspec-rails', '~> 3.0'
+gem 'sqlite3'
+
+gem 'byebug'
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 makicamel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# BulletmarkRepairer
+
+BulletmarkRepairer is an auto corrector for N+1 queries detected at runtime on Ruby on Rails application using [Bullet](https://github.com/flyerhzm/bullet) and [Parser](https://github.com/whitequark/parser).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bulletmark_repairer', group :development, :test
+```
+
+## Usage
+
+Run rails server or rspec with REPAIR=1 to autocorrect when N+1 queries are caused.
+
+```bash
+REPAIR=1 rails server
+REPAIR=1 rspec
+```
+
+### How BulletmarkRepairer auto corrects
+
+After receiving Bullet's N+1 notification, find the code that the instance variable is assigned and add `includes` to it.  
+Currently, only the controller directory is a candidate for auto correct.  
+(We plan to implement allow list in the future)  
+Also when N+1 occurs in the views, correct the controller.
+
+### Disclaimer
+
+#### BulletmarkRepairer is *NOT* safe
+
+You must check that auto corrects are correct before you commit.  
+For example, when the associations to include depends on the request parameters, human intervention is required.
+
+```ruby
+def index
+  # Required associations depend on the parameters
+  @plays = Play.ransack(params[:q])
+end
+```
+
+#### BulletmarkRepairer is *NOT* complete
+
+You can check `log/bulletmark_repairer.log` for files where N+1 is detected but not auto corrected.  
+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
+end
+```
+
+### Configuration
+
+To customize, add `config/initializers/bulletmark_repairer.rb`:
+
+```ruby
+BulletmarkRepairer.configure do |config|
+  # when you want to output log to Rails.logger
+  config.logger = Rails.logger
+  # when BulletmarkRepairer malfunctions, skip the file
+  config.skip_file_list = %w[app/controllers/plays_controller.rb]
+  # when you want to debug bulletmark_repairer's errors
+  config.debug = true
+end
+```
+
+- `logger`: Injectable logger. In default `Logger.new("#{Rails.root}/log/bulletmark_repairer.log")`
+- `skip_file_list`: File list to skip to auto correct. In default `[]`
+- `debug`: To raise BulletmarkRepairer's error or not. In default `false`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/makicamel/bulletmark_repairer>. 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/makicamel/bulletmark_repairer/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BulletmarkRepairer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/makicamel/bulletmark_repairer/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/bulletmark_repairer/associations_builder.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module BulletmarkRepairer
+  class AssociationsBuilder
+    def build(marker)
+      return if marker.skip?
+
+      if associations[marker.index]
+        associations[marker.index].add(marker)
+      else
+        associations[marker.index] = Associations.new(marker)
+      end
+    end
+
+    def associations
+      @associations ||= {}
+    end
+  end
+
+  class Associations
+    extend Forwardable
+
+    def_delegators :@marker, :file_name, :instance_variable_name
+
+    def add(child_marker)
+      build_associations!(marker: child_marker, associations: @marker.associations, parent_keys: [:base])
+    end
+
+    def corrector(dir)
+      BulletmarkRepairer::CorrectorBuilder.new(
+        dir:,
+        marker: @marker,
+        associations: @associations
+      ).execute
+    end
+
+    private
+
+    def initialize(marker)
+      @marker = marker
+      @associations = { base: marker.associations }
+    end
+
+    # @return [Hash, nil]
+    def build_associations!(marker:, associations:, parent_keys:)
+      key = formed_key(marker:, associations:)
+      if key
+        modify_value(key:, marker:, parent_keys:)
+      else
+        new_parent_keys = parent_keys
+        new_parent_keys.append(0) if associations.is_a?(Array)
+        associations.each do |association_values|
+          next unless association_values.is_a?(Hash)
+
+          association_values.each do |key, value|
+            values = value.is_a?(Array) ? value : [value]
+            build_associations!(marker:, associations: { key => values }, parent_keys: new_parent_keys)
+          end
+        end
+      end
+    end
+
+    # @return [Symbol, nil]
+    def formed_key(marker:, associations:)
+      case associations
+      when Hash
+        BulletmarkRepairer.key(marker.base_class, @marker.base_class, associations.keys) ||
+          BulletmarkRepairer.key(marker.base_class, @marker.base_class, associations.values.flatten)
+      when Array
+        BulletmarkRepairer.key(marker.base_class, @marker.base_class, associations)
+      else # Symbol, String
+        BulletmarkRepairer.key(marker.base_class, @marker.base_class, [associations])
+      end
+    end
+
+    def modify_value(key:, marker:, parent_keys:)
+      case @associations.dig(*parent_keys)
+      when Hash
+        # when key is in value
+        if @associations.dig(*parent_keys)[key].nil?
+          last_key = @associations.dig(*parent_keys).keys.first
+          if @associations.dig(*parent_keys)[last_key].is_a?(Array)
+            @associations.dig(*parent_keys)[last_key].delete(key)
+            @associations.dig(*parent_keys)[last_key].append(key => marker.associations)
+          else
+            @associations.dig(*parent_keys)[last_key] = { key => marker.associations }
+          end
+        # when key is in key
+        else
+          value = if @associations.dig(*parent_keys)[key].is_a?(Array)
+                    @associations.dig(*parent_keys)[key] + marker.associations
+                  else
+                    [@associations.dig(*parent_keys)[key], *marker.associations]
+                  end
+          @associations.dig(*parent_keys)[key] = value
+        end
+      when Array
+        @associations.dig(*parent_keys).delete(key)
+        @associations.dig(*parent_keys).append(key => marker.associations)
+      else # Symbol, String
+        last_key = parent_keys.slice!(-1)
+        @associations.dig(*parent_keys)[last_key] = { key => marker.associations }
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/bulletmark_repairer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  def self.associations
+    @associations ||= ApplicationAssociations.new
+  end
+
+  def self.key(target_klass_name, base_klass_name, candidates)
+    associations.key(target_klass_name, base_klass_name, candidates)
+  end
+
+  def self.reset_associations
+    @associations = nil
+  end
+
+  class ApplicationAssociations
+    def key(target_klass_name, base_klass_name, candidates)
+      key = target_klass_name.underscore
+      matched_candidates = candidates - (candidates - @associations[base_klass_name][:associations])
+      if key.pluralize.to_sym.in?(candidates)
+        key.pluralize.to_sym
+      elsif key.singularize.to_sym.in?(candidates)
+        key.singularize.to_sym
+      else
+        index = matched_candidates.index do |matched_candidate|
+          key.pluralize.to_sym.in?(@associations[base_klass_name][:aliases][matched_candidate]) ||
+            key.singularize.to_sym.in?(@associations[base_klass_name][:aliases][matched_candidate])
+        end
+        matched_candidates[index] if index
+      end
+    end
+
+    private
+
+    def initialize
+      blank_array_hash = Hash.new { |hash, key| hash[key] = [] }
+      @associations = Hash.new { |hash, key| hash[key] = { associations: [], aliases: blank_array_hash } }
+      ::ActiveRecord::Base
+        .descendants
+        .select { |klass| klass.respond_to?(:reflect_on_all_associations) }
+        .each do |klass|
+          klass.reflect_on_all_associations.each do |association_instance|
+            association = association_instance.respond_to?(:delegate_reflection) ? association_instance.delegate_reflection : association_instance
+            klass_name = association.active_record.name
+            association_name = association.name
+            @associations[klass_name][:associations] |= [association_name]
+            next unless association.options[:source]
+
+            alias_name = association.instance_of?(::ActiveRecord::Reflection::HasManyReflection) ? association.options[:source].to_s.pluralize.to_sym : association.options[:source]
+            @associations[klass_name][:aliases][association.name] |= [alias_name]
+          end
+        end
+    end
+  end
+end

data/lib/bulletmark_repairer/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  class Configration
+    attr_accessor :skip_file_list, :logger
+    attr_writer :debug
+
+    def initialize
+      @debug = false
+      @skip_file_list = []
+      @logger = Logger.new("#{Rails.root}/log/bulletmark_repairer.log")
+    end
+
+    def debug?
+      @debug
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configration.new
+    end
+  end
+end

data/lib/bulletmark_repairer/controller_corrector.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class ControllerCorrector < Parser::TreeRewriter
+  def on_class(node)
+    node
+      .children
+      .each do |child_node|
+        type, identifier = child_node.to_sexp_array.take(2)
+        case type
+        when :def
+          target_nodes[identifier] = child_node
+        when :begin
+          child_node.children.each do |grand_child_node|
+            type, identifier, callback_type, (_, callback_identifier) = grand_child_node.to_sexp_array
+            if type == :def
+              target_nodes[identifier] = grand_child_node
+            elsif callback_type.in? %i[before_action after_action around_action]
+              callbacks.append callback_identifier
+            end
+          end
+        end
+      end
+    action_node = target_nodes.delete(action)
+    insert_includes(node: action_node)
+    return if patched?
+
+    callbacks.each { |callback_identifier| insert_includes(node: target_nodes[callback_identifier]) }
+  end
+
+  private
+
+  def patched?
+    @patched ||= false
+  end
+
+  def target_nodes
+    @target_nodes ||= {}
+  end
+
+  def callbacks
+    @callbacks ||= []
+  end
+
+  def insert_includes(node:)
+    return if patched?
+    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
+    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)
+            target_node = target_nodes.delete(child_node.to_sexp_array.last)
+            insert_includes(node: target_node)
+          else
+            insert_includes(node: child_node)
+          end
+        end
+    end
+  end
+
+  def action
+    :__EMBEDDED_ACTION__
+  end
+
+  def instance_variable_name
+    :__EMBEDDED_INSTANCE_VARIABLE_NAME__
+  end
+
+  def associations
+    '__EMBEDDED_ASSOCIATIONS__'
+  end
+end

data/lib/bulletmark_repairer/corrector.rb

@@ -0,0 +1,56 @@
+# 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:) }
+    end
+  end
+
+  def line_no
+    __EMBEDDED_LINE_NO__
+  end
+
+  def associations
+    '__EMBEDDED_ASSOCIATIONS__'
+  end
+end

data/lib/bulletmark_repairer/corrector_builder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  class CorrectorBuilder
+    ASSOCIATIONS = '__EMBEDDED_ASSOCIATIONS__'
+    LINE_NO = '__EMBEDDED_LINE_NO__'
+    ACTION = '__EMBEDDED_ACTION__'
+    INSTANCE_VARIABLE_NAME = '__EMBEDDED_INSTANCE_VARIABLE_NAME__'
+
+    def initialize(dir:, marker:, associations:)
+      @dir = dir
+      @marker = marker
+      @associations = associations
+      @action = marker.action
+      @instance_variable_name = marker.instance_variable_name
+    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
+    end
+  end
+end

data/lib/bulletmark_repairer/markers.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module BulletmarkRepairer
+  class Markers
+    extend Forwardable
+
+    def_delegator :@markers, :each
+
+    def initialize(notifications, controller:, action:)
+      @markers = {}
+      notifications.collection.to_a.each do |notification|
+        next unless notification.is_a?(::Bullet::Notification::NPlusOneQuery)
+
+        base_class = notification.instance_variable_get(:@base_class)
+        if @markers[base_class]
+          @markers[base_class].add_association(notification)
+        else
+          @markers[base_class] = Marker.new(
+            notification,
+            controller:,
+            action:
+          )
+        end
+      end
+    end
+  end
+
+  class Marker
+    attr_reader :base_class, :associations, :action, :file_name, :instance_variable_name, :index
+
+    def initialize(notification, controller:, action:)
+      @base_class = notification.instance_variable_get(:@base_class)
+      @stacktraces = notification.instance_variable_get(:@callers)
+      @associations = notification.instance_variable_get(:@associations)
+      @controller = controller
+      @action = action
+      set_up
+    end
+
+    def add_association(notification)
+      @associations += notification.instance_variable_get(:@associations)
+    end
+
+    def skip?
+      log_patchable_files_not_be_found
+      index.nil? || file_name.remove("#{Rails.root}/").in?(BulletmarkRepairer.config.skip_file_list)
+    end
+
+    def n_plus_one_in_view?
+      @n_plus_one_in_view
+    end
+
+    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}) }
+
+      if n_plus_one_in_view?
+        # TODO: Check the action is in the base controller file
+        @file_name = "#{Rails.root}/app/controllers/#{@controller}_controller.rb"
+        view_file_index = @stacktraces.index do |stacktrace|
+          stacktrace =~ %r{\A(#{Rails.root}/app/views/[./\w]+):\d+:in `[\w]+'\z} && !Pathname.new(Regexp.last_match(1)).basename.to_s.start_with?('_')
+        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
+            break if @instance_variable_name || view_yield_index.zero?
+
+            view_yield_index -= 1
+            line = lines[view_yield_index]
+            @instance_variable_name = line&.scan(/\b?(@[\w]+)\b?/)&.flatten&.last
+          end
+        end
+        @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
+        File.open(@file_name) do |f|
+          lines = f.readlines
+          loop do
+            break if @instance_variable_name || controller_yield_index.zero?
+
+            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
+    end
+  end
+end

data/lib/bulletmark_repairer/patcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'securerandom'
+require 'parser/runner/ruby_rewrite'
+
+module BulletmarkRepairer
+  class Pathcer
+    def self.execute(notifications:, controller:, action:)
+      new(notifications:, controller:, action:).execute
+    end
+
+    def execute
+      @markers.each do |_base_class, marker|
+        @associations_builder.build(marker)
+      end
+      @associations_builder.associations.each do |_index, associations|
+        path = "#{Rails.root}/tmp/#{SecureRandom.hex(10)}"
+        FileUtils.mkdir(path)
+        Parser::Runner::RubyRewrite.go(%W[-l #{associations.corrector(path)} -m #{associations.file_name}])
+        FileUtils.rm_r(path)
+      end
+    end
+
+    private
+
+    def initialize(notifications:, controller:, action:)
+      @markers = Markers.new(notifications, controller:, action:)
+      @associations_builder = BulletmarkRepairer::AssociationsBuilder.new
+    end
+  end
+end

data/lib/bulletmark_repairer/rack.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      BulletmarkRepairer.reset_associations
+      @app.call(env)
+    ensure
+      begin
+        if Thread.current[:bullet_notification_collector].notifications_present?
+          BulletmarkRepairer::Pathcer.execute(
+            notifications: Thread.current[:bullet_notification_collector],
+            controller: env['action_dispatch.request.parameters']['controller'],
+            action: env['action_dispatch.request.parameters']['action']
+          )
+        end
+      rescue StandardError => e
+        raise e if BulletmarkRepairer.config.debug?
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module BulletmarkRepairer
+  class Railtie < ::Rails::Railtie
+    initializer 'bulletmark_repairer' do |app|
+      require 'bullet'
+      require 'bulletmark_repairer/rack'
+      app.middleware.insert_after Bullet::Rack, BulletmarkRepairer::Rack
+    end
+  end
+end

data/lib/bulletmark_repairer/version.rb

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

data/lib/bulletmark_repairer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bulletmark_repairer/version'
+require 'bulletmark_repairer/railtie' if ENV['REPAIR']
+require 'bulletmark_repairer/bulletmark_repairer'
+require 'bulletmark_repairer/associations_builder'
+require 'bulletmark_repairer/configuration'
+require 'bulletmark_repairer/corrector_builder'
+require 'bulletmark_repairer/markers'
+require 'bulletmark_repairer/patcher'
+
+module BulletmarkRepairer
+  class Error < StandardError; end
+end

data/sig/bulletmark_repairer.rbs

@@ -0,0 +1,4 @@
+module BulletmarkRepairer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: bulletmark_repairer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- makicamel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bullet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auto corrector for N+1 queries detected at runtime with Bullet.
+email:
+- unright@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bulletmark_repairer.rb
+- lib/bulletmark_repairer/associations_builder.rb
+- lib/bulletmark_repairer/bulletmark_repairer.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/version.rb
+- sig/bulletmark_repairer.rbs
+homepage: https://github.com/makicamel/bulletmark_repairer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makicamel/bulletmark_repairer
+  source_code_uri: https://github.com/makicamel/bulletmark_repairer
+  changelog_uri: https://github.com/makicamel/bulletmark_repairer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Auto corrector for N+1 queries detected at runtime with Bullet
+test_files: []