arlequin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64dab272387e862b66546a8de88779cc36ffbdfaa0a6082125b8404509fec181
-  data.tar.gz: 0c1d6fe9c4af985484476e81645ce54a1a1391ed19765276dd9d1915bc12b514
+  metadata.gz: c730c5e938ae2adf97538d4d30c69118a6dc4a9f8c290ed476cb8ea7d9115975
+  data.tar.gz: c815726ab257c2c478f55783ca90e1e7a5f948b819099fc607ffad1114336cfb
 SHA512:
-  metadata.gz: 6dab0e3d89077eccf1a50591045e75720bade0b638ff4ab5c2e892c7297b6b12c314cdb25047094b50ac4a45895e18ebb6e2a742409dc290cb7d8620fa911995
-  data.tar.gz: 194ba82a1169e3abec5d4114bd1fae8e3c51b169103f8ae3c2ae8fea8cb4bedc596e0681fbb75840fa6b94f0ea34e1e8acf431eb71e6ddf5efb9097fca91f503
+  metadata.gz: 726f9a8bb3f4c94aca726b43cdf3aa4bb09101122690ce78eab7ac90fa0ba34b4a2a222e39f6ebad1e9cb3f94f72f4b3fb9aa79ba2b8dcf889538f6db35af5e0
+  data.tar.gz: b87de6cdb5c012cb6471a5b6497f3f6cb765774fe4f87ab6837ed496f07b32b106971a0fe5d6b473041a592a0d42c220afc85602102987b783d10345d77daeb4

data/lib/arlequin/middleware.rb

@@ -1,40 +1,107 @@
 # frozen_string_literal: true
 
 module Arlequin
+  ##
+  # Middleware to detect and warn about N+1 queries in a Rails application.
   class Middleware
+    ##
+    # Initializes the middleware with the given app.
+    #
+    # @param app [Object] The Rack application this middleware wraps.
     def initialize(app)
       @app = app
     end
 
+    ##
+    # Processes the incoming request, detects N+1 queries, and injects a warning
+    # into the HTML response if necessary.
+    #
+    # @param env [Hash] The Rack environment.
+    # @return [Array] The status, headers, and response of the Rack application.
     def call(env)
-      # Set up a query counter
       @queries = Hash.new { |hash, key| hash[key] = 0 }
-
       ActiveSupport::Notifications.subscribe("sql.active_record", &method(:on_sql))
 
       status, headers, response = @app.call(env)
 
-      # Detect and log N+1 queries
-      log_n_plus_one_warnings
+      if n_plus_one_detected?
+        html_fragment = generate_html_warning
+        response = inject_html_fragment(response, html_fragment)
+      end
+
+      ActiveSupport::Notifications.unsubscribe("sql.active_record")
 
       [ status, headers, response ]
     end
 
     private
 
+    ##
+    # Callback for ActiveSupport notifications on SQL queries.
+    #
+    # @param _name [String] The event name.
+    # @param _start [Time] The start time of the event.
+    # @param _finish [Time] The finish time of the event.
+    # @param _id [String] The event ID.
+    # @param payload [Hash] The event payload containing SQL information.
     def on_sql(_name, _start, _finish, _id, payload)
-      return if payload[:name] == "SCHEMA" # Skip schema queries
+      return if payload[:name] == "SCHEMA"
 
       query = payload[:sql]
       @queries[query] += 1
     end
 
-    def log_n_plus_one_warnings
+    ##
+    # Generates warnings for detected N+1 queries.
+    #
+    # @return [Array<String>] The list of N+1 query warnings.
+    def n_plus_one_warnings
+      warnings = []
+
       @queries.each do |query, count|
         if count > 1
-          Rails.logger.warn("N+1 query detected: #{query}, executed #{count} times")
+          warnings << "N+1 query detected: #{query}, executed #{count} times"
         end
       end
+
+      warnings
+    end
+
+    ##
+    # Checks if any N+1 queries have been detected.
+    #
+    # @return [Boolean] True if N+1 queries are detected, otherwise false.
+    def n_plus_one_detected?
+      @queries.values.any? { |count| count > 1 }
+    end
+
+    ##
+    # Generates an HTML warning for detected N+1 queries.
+    #
+    # @return [String] The HTML warning to be injected into the response.
+    def generate_html_warning
+      "<div style='z-index: 9999; position: fixed; bottom: 0; left: 0; width: 100%; background-color: blue; color: white; text-align: center; padding: 5px;'>" +
+        "N+1 query detected! Check your queries. " +
+        n_plus_one_warnings.join("<br>") +
+      "</div>"
+    end
+
+    ##
+    # Injects an HTML fragment into the response body.
+    #
+    # @param response [Array<String>] The original response body.
+    # @param fragment [String] The HTML fragment to inject.
+    # @return [Array<String>] The modified response body.
+    def inject_html_fragment(response, fragment)
+      body = + ""
+
+      response.each do |part|
+        body << part
+      end
+
+      body.sub!("</body>", "#{fragment}</body>")
+
+      [ body ]
     end
   end
 end

data/lib/arlequin.rb

@@ -1,7 +1,56 @@
 # frozen_string_literal: true
 
-class Arlequin
+require "active_support/all"
+require "arlequin/middleware"
+
+module Arlequin
+  # The `Railtie` class integrates the Arlequin middleware into Rails applications.
+  #
+  # This Railtie automatically adds the Arlequin middleware to the Rails middleware stack,
+  # but it is intended to be used only in the development environment. It helps in monitoring
+  # and providing warnings about N+1 SQL queries during development.
+  #
+  # ## Configuration
+  #
+  # To use Arlequin in your Rails application, you should include it in the development group
+  # of your Gemfile and require it in the application configuration.
+  #
+  # Example Gemfile configuration:
+  #
+  #   group :development do
+  #     gem 'arlequin'
+  #   end
+  #
+  # To ensure the middleware is used in development, require the Railtie in your application:
+  #
+  #   # In `config/application.rb`
+  #   require "arlequin/railtie"
+  #
+  #   module YourApp
+  #     class Application < Rails::Application
+  #       # other configurations
+  #       # Ensure that the Railtie is required
+  #     end
+  #   end
+  #
+  # This setup will automatically add the Arlequin middleware to the middleware stack
+  # when running in development mode. The middleware will then be used to detect and
+  # provide warnings for N+1 SQL queries.
+  #
+  # ## Usage
+  #
+  # Once configured, the Arlequin middleware will monitor SQL queries and inject a warning
+  # into the response HTML if N+1 queries are detected.
+  #
+  # The Railtie is part of the Arlequin gem and is designed to integrate seamlessly into
+  # Rails applications for development purposes, facilitating easier identification and
+  # resolution of N+1 query issues.
   class Railtie < Rails::Railtie
+    # Initializes the Railtie and configures the Rails application to use the Arlequin middleware.
+    #
+    # This method is called during the initialization process of the Rails application.
+    # It adds the Arlequin middleware to the middleware stack in development environments,
+    # allowing it to intercept requests and monitor SQL queries.
     initializer "arlequin.configure_rails_initialization" do |app|
       app.middleware.use Arlequin::Middleware
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arlequin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dominic Goulet
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -32,7 +32,7 @@ extra_rdoc_files: []
 files:
 - lib/arlequin.rb
 - lib/arlequin/middleware.rb
-homepage: https://rubygems.org/gems/arlequin
+homepage: https://github.com/dominicgoulet/arlequin
 licenses:
 - MIT
 metadata: {}