bullematic 0.1.0 → 0.2.0

data/sig/generated/bullematic/detection.rbs

@@ -2,19 +2,23 @@
 
 module Bullematic
   class Detection
-    @type: Symbol
+    @source_digest: String?
 
-    @base_class: untyped
+    @context_id: untyped
 
-    @associations: Array[Symbol]
+    @method_name: String?
 
-    @call_stack: Array[String]
+    @line_number: Integer?
 
     @source_file: String?
 
-    @line_number: Integer?
+    @call_stack: Array[String]
 
-    @method_name: String?
+    @associations: Array[Symbol]
+
+    @base_class: untyped
+
+    @type: Symbol
 
     # @rbs!
     #   attr_reader type: Symbol
@@ -24,6 +28,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader type: untyped
 
     # @rbs!
@@ -34,6 +40,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader base_class: untyped
 
     # @rbs!
@@ -44,6 +52,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader associations: untyped
 
     # @rbs!
@@ -54,6 +64,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader call_stack: untyped
 
     # @rbs!
@@ -64,6 +76,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader source_file: untyped
 
     # @rbs!
@@ -74,6 +88,8 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader line_number: untyped
 
     # @rbs!
@@ -84,14 +100,49 @@ module Bullematic
     #   attr_reader source_file: String?
     #   attr_reader line_number: Integer?
     #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
     attr_reader method_name: untyped
 
+    # @rbs!
+    #   attr_reader type: Symbol
+    #   attr_reader base_class: untyped
+    #   attr_reader associations: Array[Symbol]
+    #   attr_reader call_stack: Array[String]
+    #   attr_reader source_file: String?
+    #   attr_reader line_number: Integer?
+    #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
+    attr_reader context_id: untyped
+
+    # @rbs!
+    #   attr_reader type: Symbol
+    #   attr_reader base_class: untyped
+    #   attr_reader associations: Array[Symbol]
+    #   attr_reader call_stack: Array[String]
+    #   attr_reader source_file: String?
+    #   attr_reader line_number: Integer?
+    #   attr_reader method_name: String?
+    #   attr_reader context_id: untyped
+    #   attr_reader source_digest: String?
+    attr_reader source_digest: untyped
+
     # @rbs type: Symbol
     # @rbs base_class: untyped
     # @rbs associations: untyped
     # @rbs call_stack: Array[String]
+    # @rbs context_id: untyped
+    # @rbs source_digest: String?
     # @rbs return: void
-    def initialize: (type: Symbol, base_class: untyped, associations: untyped, call_stack: Array[String]) -> void
+    def initialize: (type: Symbol, base_class: untyped, associations: untyped, call_stack: Array[String], ?context_id: untyped, ?source_digest: String?) -> void
+
+    # @rbs data: Hash[String, untyped]
+    # @rbs return: Detection
+    def self.from_h: (Hash[String, untyped] data) -> Detection
+
+    # @rbs return: Hash[String, untyped]
+    def to_h: () -> Hash[String, untyped]
 
     # : () -> String
     def model_class_name: () -> String
@@ -99,6 +150,9 @@ module Bullematic
     # : () -> bool
     def fixable?: () -> bool
 
+    # : () -> Array[untyped]
+    def fingerprint: () -> Array[untyped]
+
     private
 
     # @rbs assocs: untyped
@@ -113,5 +167,21 @@ module Bullematic
 
     # : () -> bool
     def skip_path?: () -> bool
+
+    # @rbs filepath: String
+    # @rbs paths: Array[String]
+    # @rbs return: bool
+    def path_in?: (String filepath, Array[String] paths) -> bool
+
+    # @rbs path: String
+    # @rbs return: Pathname
+    def expand_path: (String path) -> Pathname
+
+    # @rbs path: String
+    # @rbs return: Pathname
+    def absolute_path: (String path) -> Pathname
+
+    # @rbs return: String?
+    def current_source_digest: () -> String?
   end
 end

data/sig/generated/bullematic/evidence_store.rbs

@@ -0,0 +1,35 @@
+# Generated from lib/bullematic/evidence_store.rb with RBS::Inline
+
+module Bullematic
+  class EvidenceStore
+    ENV_KEY: ::String
+
+    DEFAULT_PATH: ::String
+
+    # : () -> bool
+    def self.recording?: () -> bool
+
+    # : () -> String
+    def self.path: () -> String
+
+    # @rbs detection: Detection
+    # @rbs filepath: String
+    # @rbs return: void
+    def self.append: (Detection detection, ?String filepath) -> void
+
+    # @rbs filepath: String
+    # @rbs return: void
+    def self.clear: (?String filepath) -> void
+
+    # @rbs filepath: String
+    # @rbs return: Array[Detection]
+    def self.read: (?String filepath) -> Array[Detection]
+
+    # @rbs filepath: String
+    # @rbs return: void
+    private def self.reject_symlink!: (String filepath) -> void
+
+    # : (String, Integer) { (File) -> untyped } -> untyped
+    private def self.open_evidence: (String, Integer) { (File) -> untyped } -> untyped
+  end
+end

data/sig/generated/bullematic/fixer.rbs

@@ -12,8 +12,17 @@ module Bullematic
     # : () -> void
     def self.clear: () -> void
 
-    # : () -> void
-    def self.apply_fixes: () -> void
+    # : () -> Hash[Symbol, Integer]
+    def self.apply_fixes: () -> Hash[Symbol, Integer]
+
+    # : () -> Array[Detection]
+    private def self.queue_store: () -> Array[Detection]
+
+    # : () -> Mutex
+    private def self.queue_mutex: () -> Mutex
+
+    # : () -> Array[Detection]
+    private def self.drain_queue: () -> Array[Detection]
 
     # @rbs filepath: String
     # @rbs detections: Array[Detection]
@@ -26,8 +35,55 @@ module Bullematic
     # @rbs return: AST::Finder::QueryLocation?
     private def self.find_query_location: (AST::Finder finder, Detection detection) -> AST::Finder::QueryLocation?
 
+    # @rbs finder: AST::Finder
+    # @rbs detections: Array[Detection]
+    # @rbs logger: BullematicLogger
+    # @rbs filepath: String
+    # @rbs return: Array[Hash[Symbol, untyped]]
+    private def self.build_requests: (AST::Finder finder, Array[Detection] detections, BullematicLogger logger, String filepath) -> Array[Hash[Symbol, untyped]]
+
+    # @rbs detection: Detection
+    # @rbs return: bool
+    private def self.valid_associations?: (Detection detection) -> bool
+
+    # @rbs detection: Detection
+    # @rbs candidates: Array[Detection]
+    # @rbs consumed: Array[Detection]
+    # @rbs seen: Array[String]
+    # @rbs finder: AST::Finder
+    # @rbs return: Array[untyped]
+    private def self.association_tree: (Detection detection, Array[Detection] candidates, Array[Detection] consumed, Array[String] seen, AST::Finder finder) -> Array[untyped]
+
+    # @rbs parent: Detection
+    # @rbs association: Symbol
+    # @rbs candidates: Array[Detection]
+    # @rbs finder: AST::Finder
+    # @rbs return: Detection?
+    private def self.nested_detection: (Detection parent, Symbol association, Array[Detection] candidates, AST::Finder finder) -> Detection?
+
+    # @rbs detection: Detection
+    # @rbs return: String?
+    private def self.normalized_method: (Detection detection) -> String?
+
+    # @rbs left: Detection
+    # @rbs right: Detection
+    # @rbs return: bool
+    private def self.same_execution_location?: (Detection left, Detection right) -> bool
+
+    # @rbs name: String
+    # @rbs return: untyped
+    private def self.constantize_model: (String name) -> untyped
+
+    # @rbs filepath: String
+    # @rbs source: String
+    # @rbs expected_digest: String
+    # @rbs return: void
+    private def self.atomic_write: (String filepath, String source, String expected_digest) -> void
+
     # @rbs filepath: String
+    # @rbs source: String
+    # @rbs mode: Integer
     # @rbs return: void
-    private def self.backup_file: (String filepath) -> void
+    private def self.backup_file: (String filepath, String source, Integer mode) -> void
   end
 end

data/sig/generated/bullematic/integrations/rails.rbs

@@ -3,6 +3,7 @@
 module Bullematic
   module Integrations
     class Railtie < ::Rails::Railtie
+      BULLET_MIDDLEWARE_INITIALIZER: untyped
     end
   end
 
@@ -16,5 +17,11 @@ module Bullematic
     # @rbs env: Hash[String, untyped]
     # @rbs return: untyped
     def call: (Hash[String, untyped] env) -> untyped
+
+    private
+
+    # @rbs env: Hash[String, untyped]
+    # @rbs return: void
+    def capture_notifications: (Hash[String, untyped] env) -> void
   end
 end

data/sig/generated/bullematic/logger.rbs

@@ -35,6 +35,11 @@ module Bullematic
     # @rbs return: void
     def log_fix: (String filepath, Detection detection) -> void
 
+    # @rbs filepath: String
+    # @rbs detection: Detection
+    # @rbs return: void
+    def log_plan: (String filepath, Detection detection) -> void
+
     # @rbs filepath: String
     # @rbs detection: Detection
     # @rbs reason: String

data/sig/generated/bullematic/notifier.rbs

@@ -5,26 +5,30 @@ module Bullematic
     # : () -> void
     def self.setup: () -> void
 
-    # : () -> void
-    def self.process_notifications: () -> void
+    # : () -> bool
+    def self.compatible?: () -> bool
 
-    # : () -> void
-    private def self.setup_notification_hook: () -> void
+    # @rbs context_id: untyped
+    # @rbs return: void
+    def self.process_notifications: (?context_id: untyped) -> void
+
+    # @rbs notification: untyped
+    # @rbs context_id: untyped
+    # @rbs return: Symbol?
+    private def self.process_notification: (untyped notification, untyped context_id) -> Symbol?
 
     # @rbs notification: untyped
+    # @rbs context_id: untyped
     # @rbs return: void
-    private def self.process_n_plus_one: (untyped notification) -> void
+    private def self.process_n_plus_one: (untyped notification, untyped context_id) -> void
+
+    # @rbs notification: untyped
+    # @rbs context_id: untyped
+    # @rbs return: void
+    private def self.process_unused_eager_loading: (untyped notification, untyped context_id) -> void
 
     # @rbs notification: untyped
     # @rbs return: Array[String]
     private def self.extract_call_stack: (untyped notification) -> Array[String]
-
-    module NotificationHook
-      # @rbs base_class: untyped
-      # @rbs associations: untyped
-      # @rbs path: untyped
-      # @rbs return: void
-      def initialize: (untyped base_class, untyped associations, ?untyped path) -> void
-    end
   end
 end

data/sig/generated/bullematic.rbs

@@ -10,7 +10,12 @@ module Bullematic
   class FixError < Error
   end
 
+  @configuration: Configuration?
+
+  # : () -> Configuration?
   def self.configuration: () -> Configuration?
+
+  # : (Configuration?) -> Configuration?
   def self.configuration=: (Configuration?) -> Configuration?
 
   # : () { (Configuration) -> void } -> void

data/sig/stubs/rails.rbs

@@ -41,6 +41,13 @@ module ActiveSupport
 end
 
 module Bullet
+  class BulletRailtie
+    def self.initializers: () -> Array[untyped]
+  end
+
+  class Rack
+  end
+
   def self.enable?: () -> bool
   def self.start_request: () -> void
   def self.end_request: () -> void
@@ -53,10 +60,21 @@ module Bullet
 
       def initialize: (untyped, untyped, ?untyped?) -> void
     end
+
+    class UnusedEagerLoading
+      attr_reader base_class: untyped
+      attr_reader associations: untyped
+    end
+  end
+
+  module Detector
+    module Association
+    end
   end
 end
 
 class Prism::CallNode
+  def block: () -> untyped
   def receiver: () -> untyped
   def name: () -> Symbol
   def arguments: () -> untyped
@@ -65,14 +83,37 @@ end
 
 class Prism::ConstantReadNode
   def name: () -> Symbol
+  def full_name: () -> String
+  def location: () -> untyped
+end
+
+class Prism::ConstantPathNode
+  def full_name: () -> String
   def location: () -> untyped
 end
 
 class Prism::InstanceVariableWriteNode
+  def name: () -> Symbol
+  def value: () -> untyped
+  def location: () -> untyped
+end
+
+class Prism::LocalVariableWriteNode
+  def name: () -> Symbol
   def value: () -> untyped
   def location: () -> untyped
 end
 
+class Prism::InstanceVariableReadNode
+  def name: () -> Symbol
+  def location: () -> untyped
+end
+
+class Prism::LocalVariableReadNode
+  def name: () -> Symbol
+  def location: () -> untyped
+end
+
 class Prism::SymbolNode
   def value: () -> String
 end
@@ -81,6 +122,25 @@ class Prism::ArrayNode
   def elements: () -> Array[untyped]
 end
 
+class Prism::KeywordHashNode
+  def elements: () -> Array[untyped]
+end
+
+class Prism::HashNode
+  def elements: () -> Array[untyped]
+end
+
+class Prism::AssocNode
+  def key: () -> untyped
+  def value: () -> untyped
+end
+
+class Prism::DefNode
+  def name: () -> Symbol
+  def body: () -> untyped
+  def location: () -> untyped
+end
+
 module Prism
   def self.parse: (String, ?filepath: String?) -> untyped
   def self.parse_file: (String) -> untyped

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullematic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -16,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -23,6 +26,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: prism
   requirement: !ruby/object:Gem::Requirement
@@ -37,25 +43,172 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.24.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Automatically adds includes/preload to fix N+1 queries detected by Bullet
 email:
 - t.yudai92@gmail.com
-executables: []
+executables:
+- bullematic
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- Steepfile
-- assets/logo-header.svg
+- exe/bullematic
 - lib/bullematic.rb
 - lib/bullematic/ast/finder.rb
 - lib/bullematic/ast/parser.rb
 - lib/bullematic/ast/rewriter.rb
+- lib/bullematic/cli.rb
 - lib/bullematic/configuration.rb
 - lib/bullematic/detection.rb
+- lib/bullematic/evidence_store.rb
 - lib/bullematic/fixer.rb
 - lib/bullematic/integrations/minitest.rb
 - lib/bullematic/integrations/rails.rb
@@ -63,14 +216,14 @@ files:
 - lib/bullematic/logger.rb
 - lib/bullematic/notifier.rb
 - lib/bullematic/version.rb
-- rbs_collection.lock.yaml
-- rbs_collection.yaml
 - sig/generated/bullematic.rbs
 - sig/generated/bullematic/ast/finder.rbs
 - sig/generated/bullematic/ast/parser.rbs
 - sig/generated/bullematic/ast/rewriter.rbs
+- sig/generated/bullematic/cli.rbs
 - sig/generated/bullematic/configuration.rbs
 - sig/generated/bullematic/detection.rbs
+- sig/generated/bullematic/evidence_store.rbs
 - sig/generated/bullematic/fixer.rbs
 - sig/generated/bullematic/integrations/minitest.rbs
 - sig/generated/bullematic/integrations/rails.rbs
@@ -102,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Auto-fix N+1 queries detected by Bullet at runtime
 test_files: []