arlequin 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64dab272387e862b66546a8de88779cc36ffbdfaa0a6082125b8404509fec181
-  data.tar.gz: 0c1d6fe9c4af985484476e81645ce54a1a1391ed19765276dd9d1915bc12b514
+  metadata.gz: 3083b16c52cd3b8f777180ee21b6f838768bb8da81bd5079312fad9896ba14a7
+  data.tar.gz: c6daedc9d726407f3a26aabae5aa38865d2470cb1e24cf9f1fffd47d4106d761
 SHA512:
-  metadata.gz: 6dab0e3d89077eccf1a50591045e75720bade0b638ff4ab5c2e892c7297b6b12c314cdb25047094b50ac4a45895e18ebb6e2a742409dc290cb7d8620fa911995
-  data.tar.gz: 194ba82a1169e3abec5d4114bd1fae8e3c51b169103f8ae3c2ae8fea8cb4bedc596e0681fbb75840fa6b94f0ea34e1e8acf431eb71e6ddf5efb9097fca91f503
+  metadata.gz: 8ae1b8e8d9d99928a76d562bbdfef3b2effe853f60fb2cfe2943a098532d919cb99a9c7f4b79396d09d88f4361794cd9656e62850c0465f370b8fc7dc6b1cfd3
+  data.tar.gz: a361f0f8055ed4e5f97580ede4ba096c6d6edb3638fe3c51e6078e54e833345a6f78f9d8524b118a78f860224b326e41d9a45d36e643db1917ea76c18c214f3f

data/.gitignore

@@ -0,0 +1,4 @@
+/doc/
+/tmp/
+/log/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "http://rubygems.org"
+
+gemspec
+
+gem "rubocop-rails-omakase", require: false, group: [ :development ]

data/Gemfile.lock

@@ -0,0 +1,232 @@
+PATH
+  remote: .
+  specs:
+    arlequin (0.1.1)
+      rails (>= 5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      marcel (~> 1.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    drb (2.2.1)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.14)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.6-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.1.7)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    rexml (3.3.2)
+      strscan
+    rubocop (1.65.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.35.1)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.25.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.16)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  arlequin!
+  rubocop-rails-omakase
+
+BUNDLED WITH
+   2.4.19

data/README.md

@@ -0,0 +1,77 @@
+# Arlequin
+
+**Arlequin** is a Ruby gem that helps detect and warn about N+1 SQL queries in Rails applications. It includes middleware that integrates seamlessly with your Rails application to improve performance by identifying inefficient database queries.
+
+## Features
+
+- **N+1 Query Detection**: Automatically detects and warns about N+1 query problems.
+- **Integration**: Easy integration with Rails applications through a Railtie.
+- **Performance Insights**: Provides detailed insights into query performance issues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arlequin', group: [ :development ]
+```
+
+Then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Basic Setup
+
+To start using Arlequin, simply add the following to your Rails application’s configuration file (config/application.rb):
+
+```ruby
+require 'arlequin'
+```
+
+### Middleware
+Arlequin integrates with Rails as middleware. It will automatically start monitoring SQL queries for N+1 problems.
+No additional setup is required beyond including it in your Gemfile and configuration.
+
+## Example
+
+Suppose you have a Rails application with a Post model that has many Comments. If you inadvertently write code like:
+
+```ruby
+@posts = Post.all
+@posts.each do |post|
+  puts post.comments.count
+end
+```
+
+Arlequin will detect this N+1 query issue and warn you about it in the UI.
+
+## Development
+
+To contribute to Arlequin, clone the repository and run the test suite:
+
+```bash
+git clone https://github.com/dominicgoulet/arlequin.git
+cd arlequin
+bundle install
+rake test
+```
+
+Make sure to write tests for any new features or bug fixes you add.
+Follow the existing coding style and conventions used in the project.
+
+## Contributing
+
+We welcome contributions! Please submit pull requests and issues through GitHub.
+Ensure your code adheres to the project’s style and includes appropriate tests.
+
+## License
+
+Arlequin is released under the MIT License.
+
+## Contact
+
+For any questions or feedback, feel free to reach out to us at [dominic@dominicgoulet.com].

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "minitest/test_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = [ "test/**/*_test.rb" ]
+end
+
+task default: :test

data/arlequin.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = "arlequin"
+  s.version     = "0.1.2"
+  s.summary     = "Arlequin performance logger gem"
+  s.description = "Performance Logger Gem"
+
+  s.license     = "MIT"
+
+  s.author      = "Dominic Goulet"
+  s.email       = "dominic@dominicgoulet.com"
+  s.homepage    = "https://github.com/dominicgoulet/arlequin"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|translation)/}) }
+  end
+
+  s.metadata = {
+    "source_code_uri" => s.homepage
+  }
+
+  s.add_dependency "rails", ">= 5.0"
+end

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.2
 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
@@ -25,17 +25,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 description: Performance Logger Gem
-email: dominic.goulet@gmail.com
+email: dominic@dominicgoulet.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- arlequin.gemspec
 - lib/arlequin.rb
 - lib/arlequin/middleware.rb
-homepage: https://rubygems.org/gems/arlequin
+homepage: https://github.com/dominicgoulet/arlequin
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/dominicgoulet/arlequin
 post_install_message:
 rdoc_options: []
 require_paths: