prosopite 0.1.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a2d861398e1f7a76cc71705f68d1f7287ca1343b3bd8fcf7e909f941682125
-  data.tar.gz: 586d0e356edfb83152c538bc4b017d9e8009d6fcd1ba746ec2cf677a97ea7f23
+  metadata.gz: f4f17a47aa9ab87c866f3fb9c493d3b5baae8248781346e497b90b3dc23f488d
+  data.tar.gz: b9e0e29a7774adb0f8600d8fedeb2de8f9a8149468d216e1ac2e05e587445939
 SHA512:
-  metadata.gz: 3c4e9d238b5f10d8f57531d84024758d3a6e05b4b3cefb49317c1576a0cbcf71287bcd77050ddfc073b1f03cdb3a601bb6f33a49f4488f7ab4483f51f19e7af0
-  data.tar.gz: 3f22640ed22014cd38f47e770de44253314e134192745fc3abf43d14374d815d249929f4e1dd754c46318e579ee40cf1b76ba90aa7009dd18c15f42a642aa39c
+  metadata.gz: c143ec186f20ee7e770619074a532f1bec494f2149e572be083eea05ee569ded551611043e22acfbe36e016285081cb43502b6f79e786491eaab4d04900fd47c
+  data.tar.gz: 1e5331db9ff3ce75299cd10468ab48341a54d8f451a2487d08646f757a801a193d930c4512991d7b2fec6be3766a34cb80a081cfddef620df6a31dd82c58f25b

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 (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -44,6 +43,7 @@ DEPENDENCIES
   activerecord
   factory_bot
   minitest
+  pg_query
   prosopite!
   pry
   rake (~> 13.0)

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
 ```
@@ -186,6 +194,14 @@ Prosopite.scan
 Prosopite.finish
 ```
 
+or 
+
+```ruby
+Prosopite.scan do
+<code to scan>
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/charkost/prosopite.

data/lib/prosopite.rb

@@ -1,4 +1,3 @@
-require 'pg_query'
 
 module Prosopite
   class NPlusOneQueriesError < StandardError; end
@@ -22,6 +21,15 @@ module Prosopite
       @allow_list ||= []
 
       tc[:prosopite_scan] = true
+
+      if block_given?
+        begin
+          yield
+          finish
+        ensure
+          tc[:prosopite_scan] = false
+        end
+      end
     end
 
     def tc
@@ -71,6 +79,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
@@ -100,7 +114,7 @@ module Prosopite
 
       query.gsub!(/\btrue\b|\bfalse\b/i, "?")
 
-      query.gsub!(/[0-9+-][0-9a-f.xb+-]*/, "?")
+      query.gsub!(/[0-9+-][0-9a-f.x+-]*/, "?")
       query.gsub!(/[xb.+-]\?/, "?")
 
       query.strip!
@@ -140,8 +154,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|
@@ -152,9 +166,13 @@ 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
-      tc[:prosopite_subscribed] ||= false
-      return if tc[:prosopite_subscribed]
+      @subscribed ||= false
+      return if @subscribed
 
       ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
         sql = data[:sql]
@@ -171,7 +189,7 @@ module Prosopite
         end
       end
 
-      tc[:prosopite_subscribed] = true
+      @subscribed = true
     end
   end
 end

data/lib/prosopite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosopite
-  VERSION = "0.1.6"
+  VERSION = "1.0.1"
 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.6
+  version: 1.0.1
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-04-07 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