testoscope 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 48ce691579625e8c4b15011a87d40899d4c51452
-  data.tar.gz: 183f29ac7bd2e766d43c78eb051f42c77e67444b
+SHA256:
+  metadata.gz: 3b8d037184ba7ff1c1cd5e14d0dbeba4a9abf6787c83fd433a11701851f42059
+  data.tar.gz: 9e60451e44a9b04f4d14c0bb1142bc1bcb3635d3f62b5e524d9518ace953a6ef
 SHA512:
-  metadata.gz: 1739040d166c49b7c81b1d8dd50991b4913a12446161ae0cdfbed0cd4d287b8a11af11e64810caac6bee4d9c47e2abeb24d6bf303aede27ca297a3a5898affe1
-  data.tar.gz: 4f565be713d29e50e7929bd52852848a6ca4b7ad5d9fbbea22c352f3a2838b9f0ab059e4350142927d1ba273bf289c58bc64e596829305895c9850be57dddb72
+  metadata.gz: 87e2e7cbe4068255d34828bce780296f765c8dd48ba19230a8e7f352783ab9948aae1d3de5cf9570e09f08c14bc74a7ffea862b0684ebe15b86e15da19bf724d
+  data.tar.gz: f5aefb8afd68f1830c51f5dabd0960297a7907a6011a0672befb198e6dd65a3fe16e62f968751493c489f05c937afef7bcb8d2da0ea273f1fab6f593e34d8ad6

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.6
+
+* can run EXPLAIN queries with testoscope enabled 
+* add two more regexp on used index 

data/README.md

@@ -42,7 +42,7 @@ and in ORM it doesn't look alarming:
 
     sub_tags.where( name: names )
   
-So when names is empty, we get a dummy request.
+But when names is empty, we get a dummy request.
 
 They are not a big deal from a performance perspective, 
 but you are occupying DB connection pool and cluttering your channel with empty noise.
@@ -61,21 +61,21 @@ In either cases you may have a problem, but also may not.
 
 ### How it works? 
 Testoscope hooks to exec_query of a connection adapter, 
-for all queries runs them two times: 
-first with EXPLAIN and analyze it, 
-and the second - is for original a caller purpose.
+when sql query reach exec_query it runs two times: 
+first with EXPLAIN for tstoscope to analyze, 
+and the second - for original a caller purpose.
 
-After achieving explain result, it simply search for configured unintended behaviour markers, 
+After retrieving explain result, testoscope search for specified unintended behaviour markers, 
 like a Seq Scan substring in Postgres QUERY PLAN explained, and also collects indexes used by all queries for a final summary.
 
 ### Unintended Behaviours
-By default unintended behaviours are preconfigured for PosgtreSQL and all tables:
+By default markers are preconfigured for PosgtreSQL and full list of tables:
         
      config.unintened_key_words = ['Seq Scan', 'One-Time Filter']
      config.tables = :all
 
 But you can set any regexp you want to track inside EXPLAIN results, 
-and also you can track not all tables, but only specified ones:
+and also you can track partial list of tables:
     
     config.tables = ['cards', 'users']
   
@@ -85,32 +85,42 @@ and also you can track not all tables, but only specified ones:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'testoscope'
+group :test do 
+    gem 'testoscope'
+end
+
 ```
 
 And then execute:
 
     $ bundle
-
-Or install it yourself as:
-
-    $ gem install testoscope
-
+    
 ## Usage
 
 In test_helper.rb:
 
     require 'testoscope'
     
-    #since doubling all requests to DB is not free, 
-    #you may use ENV variable to run on demand 
+    # since doubling all requests to DB is not free, 
+    # you may use ENV variable to run on demand 
     if ENV[:RUN_TESTOSCOPE]
         Testoscope.configure { |c| 
+             # include only trace from folders
              c.back_trace_paths = [Rails.root.to_s]
+             
+             # additionaly exclude subfolders 
              c.back_trace_exclude_paths = ["#{Rails.root.to_s}/test", "#{Rails.root.to_s}/spec"]
+             
+             # unintended behaviour markers
              c.unintened_key_words = ['Seq Scan', 'One-Time Filter']
+             
+             # set true to raise error on unintended behaviour 
              c.raise_when_unintended = false
+             
+             # true to analyze everything, false to analize only by demand using suspend_global_analyze
              c.analyze = true
+             
+             # :all - to complete list, or array of specific table names: [ 'users', 'comments' ... ] 
              c.tables = :all
         }
         

data/lib/testoscope.rb

@@ -114,7 +114,8 @@ module Testoscope
         self.add_unintended_behaviour( sql, explain, app_trace )
       end
 
-      explain.scan(/Index Scan using \w+/).each{|found| add_index_used(sql, explain, found[17..-1]) }
+      explain.scan(/Index Scan using (\w+)|Index Scan on (\w+)|Index Scan Backward using (\w+)/)
+        .each{|found| add_index_used(sql, explain, found.compact.first ) }
     end
   end
 
@@ -127,7 +128,7 @@ module Testoscope
   module AdapterUpgrade
     def exec_query(sql, name = "SQL", binds = [], prepare: false)
       Testoscope.analyze(sql) {
-        super( 'EXPLAIN ' + sql, "EXPLAIN", binds, prepare: false)
+        super(  sql['EXPLAIN'] ? sql : 'EXPLAIN ' + sql, "EXPLAIN", binds, prepare: false)
       }
       super( sql, name, binds, prepare: prepare )
     end

data/lib/testoscope/version.rb

@@ -1,3 +1,3 @@
 module Testoscope
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testoscope
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - alekseyl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,7 @@ files:
 - ".idea/testoscope.iml"
 - ".idea/workspace.xml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This is simple and nice tool to inspect how application operates with current