bulletmark_repairer 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a5858e9552c2cf6259b9102c1f0980607baab37030962e55b56e83b5fd61d36
-  data.tar.gz: ebcd21ae7ab79f0113e53862fff5ef5700d24385d1eea98eb3bb731e533aff9d
+  metadata.gz: a7110364b32065ccdce57c9220481a6c3ab36265a1fbc1fcb0d40a5d6a92ceeb
+  data.tar.gz: e69d9ae29d6a2f0e013e8d974ac5634e98750c31cf57eacbbbee1ed48778f5ce
 SHA512:
-  metadata.gz: 5251a08f17df69a9d8df9c6770d823b90a4bf99949f5ce241ee78f124365e63cd655fe68b9eb6d10b6a7bc048ac4d7de87f010593fc2c492a80abadf164d1d54
-  data.tar.gz: b5f4c055095c3372ffffa0b9ae87b64c56d024b27fd177ddb99854063215cabae75692fb3d603bdaac77f01c97753a4b8e6aac7e90fc0af8905b142e3c48064d
+  metadata.gz: 4eb6a1e8d2274100f04d72f544c0dce8588b758216bfbe08968947fc535d7fe3e0fba8f7d722600737c18e52cbe468e0ed2482e48e9d9372ca18c3f66e1c05fa
+  data.tar.gz: fe6a169678171236abebdff07cf2adfef7af32066c07656ad327fbb33d692a0b9171c5b418932c653ae4a8c0eb95be823c8d29d2f17423f7fe7d8be663fd5aa2

data/CHANGELOG.md

@@ -1,7 +1,19 @@
+## [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])
+- Stop using class instance variables for thread safe [024f6c5](https://github.com/makicamel/bulletmark_repairer/commit/024f6c53f82b182a998c1e43de48d8c6c9ce5bf3)
+
 ## [0.1.1] - 2023-10-11
 
-- Support Ruby 3.0 dbdf27c6c9a7259ad9474153d2394da5bac45b43
+- Support Ruby 3.0 [dbdf27c](https://github.com/makicamel/bulletmark_repairer/commit/dbdf27c6c9a7259ad9474153d2394da5bac45b43)
 
 ## [0.1.0] - 2023-10-10
 
 - Initial release
+
+[@tricknotes]: https://github.com/tricknotes
+[@ydah]: https://github.com/ydah

data/Gemfile

@@ -8,7 +8,6 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'factory_bot_rails'
-gem 'rails'
 gem 'rspec', '~> 3.0'
 gem 'rspec-rails', '~> 3.0'
 gem 'sqlite3'

data/README.md

@@ -7,7 +7,7 @@ BulletmarkRepairer is an auto corrector for N+1 queries detected at runtime on R
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'bulletmark_repairer', group :development, :test
+gem 'bulletmark_repairer', group: %w(development test)
 ```
 
 ## Usage

data/lib/bulletmark_repairer/{bulletmark_repairer.rb → application_associations.rb}

@@ -1,18 +1,6 @@
 # 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

data/lib/bulletmark_repairer/associations_builder.rb

@@ -10,13 +10,19 @@ module BulletmarkRepairer
       if associations[marker.index]
         associations[marker.index].add(marker)
       else
-        associations[marker.index] = Associations.new(marker)
+        associations[marker.index] = Associations.new(marker, @application_associations)
       end
     end
 
     def associations
       @associations ||= {}
     end
+
+    private
+
+    def initialize
+      @application_associations = BulletmarkRepairer::ApplicationAssociations.new
+    end
   end
 
   class Associations
@@ -38,9 +44,10 @@ module BulletmarkRepairer
 
     private
 
-    def initialize(marker)
+    def initialize(marker, application_associations)
       @marker = marker
       @associations = { base: marker.associations }
+      @application_associations = application_associations
     end
 
     # @return [Hash, nil]
@@ -66,12 +73,12 @@ module BulletmarkRepairer
     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)
+        @application_associations.key(marker.base_class, @marker.base_class, associations.keys) ||
+          @application_associations.key(marker.base_class, @marker.base_class, associations.values.flatten)
       when Array
-        BulletmarkRepairer.key(marker.base_class, @marker.base_class, associations)
+        @application_associations.key(marker.base_class, @marker.base_class, associations)
       else # Symbol, String
-        BulletmarkRepairer.key(marker.base_class, @marker.base_class, [associations])
+        @application_associations.key(marker.base_class, @marker.base_class, [associations])
       end
     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,10 +46,12 @@ 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

data/lib/bulletmark_repairer/patcher.rb

@@ -5,7 +5,7 @@ require 'securerandom'
 require 'parser/runner/ruby_rewrite'
 
 module BulletmarkRepairer
-  class Pathcer
+  class Patcher
     def self.execute(notifications:, controller:, action:)
       new(notifications: notifications, controller: controller, action: action).execute
     end

data/lib/bulletmark_repairer/rack.rb

@@ -7,12 +7,11 @@ module BulletmarkRepairer
     end
 
     def call(env)
-      BulletmarkRepairer.reset_associations
       @app.call(env)
     ensure
       begin
         if Thread.current[:bullet_notification_collector].notifications_present?
-          BulletmarkRepairer::Pathcer.execute(
+          BulletmarkRepairer::Patcher.execute(
             notifications: Thread.current[:bullet_notification_collector],
             controller: env['action_dispatch.request.parameters']['controller'],
             action: env['action_dispatch.request.parameters']['action']

data/lib/bulletmark_repairer/version.rb

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

data/lib/bulletmark_repairer.rb

@@ -2,7 +2,7 @@
 
 require 'bulletmark_repairer/version'
 require 'bulletmark_repairer/railtie' if ENV['REPAIR']
-require 'bulletmark_repairer/bulletmark_repairer'
+require 'bulletmark_repairer/application_associations'
 require 'bulletmark_repairer/associations_builder'
 require 'bulletmark_repairer/configuration'
 require 'bulletmark_repairer/corrector_builder'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bulletmark_repairer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bullet
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codespellignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -68,11 +83,10 @@ files:
 - README.md
 - Rakefile
 - lib/bulletmark_repairer.rb
+- lib/bulletmark_repairer/application_associations.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

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