sql_spy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c4bb9268e7009228c6ac7528e90bfed389d8024d7d96998eda16e3b7e5f8f4
-  data.tar.gz: 90f4a5afca785eccfcb6a1223c560692f6437a66010233ab554f13eaace0c33f
+  metadata.gz: 98d9ae168c842d388db04918e4abf010ab0ece285bc4cad77d44b6606305c916
+  data.tar.gz: acfa349aeec0b8f003dd21b36286e923fb697709b7b07d4ca57abd6c1ff80823
 SHA512:
-  metadata.gz: e0564cf944ffaf168e3b9a074eec8ffcc6c04a5e6ee00be00e5eedef4c59c28c9ee052f4decf9c546dc886adea97afa30b0008fdd6fcd07884567fd4144b0cd6
-  data.tar.gz: d7c9ef7a7566bb9e605e921f28b2ae5c6b9907746efd2c030345b3d5c2e629086adc2e7e3d1ff3dd970262cb24b9f6a3cb110f4bb0cc8541beecffdb4c7046a2
+  metadata.gz: e464cc84c62c58935b5d3e8769b776a668edbfef35d51a7d0d0fc0f7de99b0545fcacc3a247dfc913ae4b2319c3bd5ce65856a581de3641a3173837f190aaf5a
+  data.tar.gz: 547c8b53ae652c54be10b3d9e77b6c4dd9a882957d64e11c3b7903df988eb5229d6e48599f88f1497d5a9c5d6cbd9fe5590d73a6e7b371a8cad5167cd9d194c5

data/.gitignore

@@ -8,5 +8,5 @@
 /tmp/
 
 .byebug_history
-test.sqlite3
+test.sqlite
 

data/.travis.yml

@@ -1,6 +1,11 @@
----
+dist: bionic
 language: ruby
+addons:
+  postgresql: "9.6"
+rvm: 2.7.1
 cache: bundler
-rvm:
-  - 2.7.1
 before_install: gem install bundler -v 2.1.4
+before_script: createdb sql_spy_test
+env:
+  - DATABASE_URL=sqlite3:///tmp/sql_spy_test.sqlite
+  - DATABASE_URL=postgres:///sql_spy_test

data/Gemfile

@@ -5,5 +5,6 @@ gemspec
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "activerecord", "~> 6.0"
+gem "pg"
 gem "sqlite3"
 gem "byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sql_spy (0.1.0)
+    sql_spy (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -22,6 +22,7 @@ GEM
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     minitest (5.14.2)
+    pg (1.2.3)
     rake (12.3.3)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
@@ -36,6 +37,7 @@ DEPENDENCIES
   activerecord (~> 6.0)
   byebug
   minitest (~> 5.0)
+  pg
   rake (~> 12.0)
   sql_spy!
   sqlite3

data/README.md

@@ -2,9 +2,9 @@
 
 <a href="https://travis-ci.com/github/lipanski/sql-spy"><img src="https://api.travis-ci.com/lipanski/sql-spy.svg?branch=master"></a>
 
-A gem to track all SQL queries performed inside a given block.
+A gem to track all SQL queries performed inside a block of code.
 
-You can use **SqlSpy** to test various things, like the total amount of queries performed by a piece of code, the amount of queries per table, inserts vs. updates or even N+1 queries. You can also use it to validate and debug your SQL.
+You can use **SqlSpy** to test the total amount of queries performed by a piece of code, the amount of queries per table, selects vs. inserts vs. updates vs. deletes, or query duration. You can also use it to validate and debug your SQL or to prevent N+1 queries.
 
 The implementation is inspired by how [ActiveRecord is tested](https://github.com/rails/rails/blob/6-0-stable/activerecord/test/cases/test_case.rb).
 
@@ -28,15 +28,11 @@ Wrap the code you'd like to track inside `SqlSpy.track {}`:
 require "sql_spy"
 
 queries = SqlSpy.track do
-  User.create(name: "Mario")
-  users = User.limit(5).to_a
-  users.each { |user| user.posts.to_a }
+  # Some code that triggers ActiveRecord queries
 end
 ```
 
-The return value of this block is **an Array containing all the queries performed inside the block**.
-
-Every query inside the Array exposes the following **methods**:
+The `SqlSpy.track` method will return **an array containing all the queries performed inside the block**. Every object inside this array exposes the following **methods**:
 
 - `#model_name`: The model name (e.g. "User").
 - `#sql`: The SQL query that was performed.
@@ -46,7 +42,7 @@ Every query inside the Array exposes the following **methods**:
 - `#update?`: Is this an *UPDATE* query?
 - `#delete?`: Is this a *DELETE* query?
 
-Here are some **ideas** of how you could use this:
+Here are some **ideas** for how you could use this:
 
 ```ruby
 # Expect less than 5 queries
@@ -66,6 +62,25 @@ queries_by_model = queries.group_by(&:model_name)
 assert queries_by_model.none? { |model_name, queries| queries.count > 1 }
 ```
 
+## Development
+
+The gem is tested with Postgres 9.6 and SQLite 3.
+
+To run tests with SQLite:
+
+```sh
+bundle exec rake
+```
+
+To run tests with Postgres:
+
+```sh
+# Create a test database
+cretedb sql_spy_test
+
+DATABASE_URL=postgres:///sql_spy_test bundle exec rake
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sql_spy.rb

@@ -1,7 +1,7 @@
 module SqlSpy
   Query = Struct.new(:name, :sql, :duration) do
     def model_name
-      name.split.first
+      String(name).split.first
     end
 
     def select?
@@ -29,7 +29,7 @@ module SqlSpy
     end
 
     def call(_name, start, finish, _message_id, values)
-      return if values[:name].nil? || IGNORED_NAMES.include?(values[:name])
+      return if IGNORED_NAMES.include?(values[:name])
       return if values[:cached]
 
       queries << Query.new(values[:name], values[:sql], (finish - start) * 1000)

data/sql-spy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "sql_spy"
-  spec.version = "0.2.0"
+  spec.version = "0.3.0"
   spec.authors = ["Florin Lipan"]
   spec.email = ["florinlipan@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_spy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Florin Lipan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: