prosopite 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e45d47e93e239165f045462c1247f33b4dae5796e1c852fd7a2a6ade0977ef2a
-  data.tar.gz: 25c2afb9c1340d3e16c3fcd2ba880becdfc674c54aaecba4d83566c6585998de
+  metadata.gz: 3df6a0299972911e48ea44330995864e2cd2191ec66c199296ba324a5fa8e639
+  data.tar.gz: 4f9ee347a8cf52fd742ee66586c7e4b601c8436a4bcabe1b1afdef5e09293f44
 SHA512:
-  metadata.gz: 3eb734873fc1c396b5312dc70fe91a4c10a8adb4658bce2302559e8d61db22cc6e54429806e99e3014308b1e236b69a34f75e59bd3b789f36145843390776998
-  data.tar.gz: 626d2a7ebaf7553647672f137696adfe2aa70fe67589b7380c2366862c85022ee560dfbe2665f7580c4cd930a95d7c94e1a59557d4674c563379fef94e197846
+  metadata.gz: 668bc7e58bcabd77231adc831054d56ca572e1e9857f87736d1fd06048c1eeaac9c0c0ab970c6ed6f8ce70670ae51277c3c4f56012d0ec61240c0e728c1f3795
+  data.tar.gz: '0341920f4f1beddc2b9c46553f9284724ecddfe50f30579a7cc9627c93fdf2d3c714bb57fd453dd7a4783a86951b9dd2cb0a79e721189bce3b89eda0c119c8bf'

data/Gemfile

@@ -5,3 +5,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+gem 'pg_query'

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    prosopite (0.1.5)
-      pg_query (~> 1.3)
+    prosopite (0.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -44,6 +43,7 @@ DEPENDENCIES
   activerecord
   factory_bot
   minitest
+  pg_query
   prosopite!
   pry
   rake (~> 13.0)

data/LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Mpampis Kostas
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -97,6 +97,12 @@ Add this line to your application's Gemfile:
 gem 'prosopite'
 ```
 
+If you're **not** using MySQL/MariaDB, you should also add:
+
+```ruby
+gem 'pg_query'
+```
+
 And then execute:
 
     $ bundle install
@@ -120,12 +126,14 @@ Prosopite auto-detection can be enabled on all controllers:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_action do
-    Prosopite.scan
-  end
-
-  after_action do
-    Prosopite.finish
+  unless Rails.env.production?
+    before_action do
+      Prosopite.scan
+    end
+
+    after_action do
+      Prosopite.finish
+    end
   end
 end
 ```
@@ -168,12 +176,12 @@ end
 
 WARNING: scan/finish should run before/after **each** test and NOT before/after the whole suite.
 
-## Whitelisting
+## Allow list
 
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-Prosopite.whitelist = ['substring_in_call_stack']
+Prosopite.allow_list = ['substring_in_call_stack']
 ```
 
 ## Scanning code outside controllers or tests

data/lib/prosopite.rb

@@ -1,4 +1,3 @@
-require 'pg_query'
 
 module Prosopite
   class NPlusOneQueriesError < StandardError; end
@@ -7,42 +6,46 @@ module Prosopite
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
-                :whitelist
+                :allow_list
 
     def scan
-      @scan ||= false
+      tc[:prosopite_scan] ||= false
       return if scan?
 
       subscribe
 
-      @query_counter = Hash.new(0)
-      @query_holder = Hash.new { |h, k| h[k] = [] }
-      @query_caller = {}
+      tc[:prosopite_query_counter] = Hash.new(0)
+      tc[:prosopite_query_holder] = Hash.new { |h, k| h[k] = [] }
+      tc[:prosopite_query_caller] = {}
 
-      @whitelist ||= []
+      @allow_list ||= []
 
-      @scan = true
+      tc[:prosopite_scan] = true
+    end
+
+    def tc
+      Thread.current
     end
 
     def scan?
-      @scan
+      tc[:prosopite_scan]
     end
 
     def finish
       return unless scan?
 
-      @scan = false
+      tc[:prosopite_scan] = false
 
       create_notifications
-      send_notifications if @notifications.present?
+      send_notifications if tc[:prosopite_notifications].present?
     end
 
     def create_notifications
-      @notifications = {}
+      tc[:prosopite_notifications] = {}
 
-      @query_counter.each do |location_key, count|
+      tc[:prosopite_query_counter].each do |location_key, count|
         if count > 1
-          fingerprints = @query_holder[location_key].map do |q|
+          fingerprints = tc[:prosopite_query_holder][location_key].map do |q|
             begin
               fingerprint(q)
             rescue
@@ -50,13 +53,13 @@ module Prosopite
             end
           end
 
-          kaller = @query_caller[location_key]
+          kaller = tc[:prosopite_query_caller][location_key]
 
-          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @whitelist.any? { |s| f.include?(s) } }
-            queries = @query_holder[location_key]
+          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @allow_list.any? { |s| f.include?(s) } }
+            queries = tc[:prosopite_query_holder][location_key]
 
             unless kaller.any? { |f| f.include?('active_record/validations/uniqueness') }
-              @notifications[queries] = kaller
+              tc[:prosopite_notifications][queries] = kaller
             end
           end
         end
@@ -67,6 +70,12 @@ module Prosopite
       if ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
         mysql_fingerprint(query)
       else
+        begin
+          require 'pg_query'
+        rescue LoadError => e
+          msg = "Could not load the 'pg_query' gem. Add `gem 'pg_query'` to your Gemfile"
+          raise LoadError, msg, e.backtrace
+        end
         PgQuery.fingerprint(query)
       end
     end
@@ -126,7 +135,7 @@ module Prosopite
 
       notifications_str = ''
 
-      @notifications.each do |queries, kaller|
+      tc[:prosopite_notifications].each do |queries, kaller|
         notifications_str << "N+1 queries detected:\n"
         queries.each { |q| notifications_str << "  #{q}\n" }
         notifications_str << "Call stack:\n"
@@ -136,8 +145,8 @@ module Prosopite
         notifications_str << "\n"
       end
 
-      Rails.logger.warn(notifications_str) if @rails_logger
-      $stderr.puts(notifications_str) if @stderr_logger
+      Rails.logger.warn(red(notifications_str)) if @rails_logger
+      $stderr.puts(red(notifications_str)) if @stderr_logger
 
       if @prosopite_logger
         File.open(File.join(Rails.root, 'log', 'prosopite.log'), 'a') do |f|
@@ -148,6 +157,10 @@ module Prosopite
       raise NPlusOneQueriesError.new(notifications_str) if @raise
     end
 
+    def red(str)
+      str.split("\n").map { |line| "\e[91m#{line}\e[0m" }.join("\n")
+    end
+
     def subscribe
       @subscribed ||= false
       return if @subscribed
@@ -158,11 +171,11 @@ module Prosopite
         if scan? && sql.include?('SELECT') && data[:cached].nil?
           location_key = Digest::SHA1.hexdigest(caller.join)
 
-          @query_counter[location_key] += 1
-          @query_holder[location_key] << sql
+          tc[:prosopite_query_counter][location_key] += 1
+          tc[:prosopite_query_holder][location_key] << sql
 
-          if @query_counter[location_key] > 1
-            @query_caller[location_key] = caller.dup
+          if tc[:prosopite_query_counter][location_key] > 1
+            tc[:prosopite_query_caller][location_key] = caller.dup
           end
         end
       end

data/lib/prosopite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosopite
-  VERSION = "0.1.5"
+  VERSION = "1.0.0"
 end

data/prosopite.gemspec

@@ -24,8 +24,6 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'pg_query', '~> 1.3'
-
   spec.add_development_dependency "pry"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "factory_bot"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: pg_query
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement