sql_spy 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2c4bb9268e7009228c6ac7528e90bfed389d8024d7d96998eda16e3b7e5f8f4
+  data.tar.gz: 90f4a5afca785eccfcb6a1223c560692f6437a66010233ab554f13eaace0c33f
+SHA512:
+  metadata.gz: e0564cf944ffaf168e3b9a074eec8ffcc6c04a5e6ee00be00e5eedef4c59c28c9ee052f4decf9c546dc886adea97afa30b0008fdd6fcd07884567fd4144b0cd6
+  data.tar.gz: d7c9ef7a7566bb9e605e921f28b2ae5c6b9907746efd2c030345b3d5c2e629086adc2e7e3d1ff3dd970262cb24b9f6a3cb110f4bb0cc8541beecffdb4c7046a2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+test.sqlite3
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "activerecord", "~> 6.0"
+gem "sqlite3"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    sql_spy (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    rake (12.3.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0)
+  byebug
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sql_spy!
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Florin Lipan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# SqlSpy
+
+<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.
+
+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.
+
+The implementation is inspired by how [ActiveRecord is tested](https://github.com/rails/rails/blob/6-0-stable/activerecord/test/cases/test_case.rb).
+
+## Usage
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "sql_spy"
+```
+
+...and install it with:
+
+```sh
+bundle install
+```
+
+Wrap the code you'd like to track inside `SqlSpy.track {}`:
+
+```ruby
+require "sql_spy"
+
+queries = SqlSpy.track do
+  User.create(name: "Mario")
+  users = User.limit(5).to_a
+  users.each { |user| user.posts.to_a }
+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**:
+
+- `#model_name`: The model name (e.g. "User").
+- `#sql`: The SQL query that was performed.
+- `#duration`: The duration of the query in milliseconds.
+- `#select?`: Is this a *SELECT* query?
+- `#insert?`: Is this an *INSERT* query?
+- `#update?`: Is this an *UPDATE* query?
+- `#delete?`: Is this a *DELETE* query?
+
+Here are some **ideas** of how you could use this:
+
+```ruby
+# Expect less than 5 queries
+assert queries.count < 5
+
+# Expect 1 INSERT query
+assert_equal 1, queries.select(&:insert?).size
+
+# Expect 2 queries to the posts table
+assert_equal 2, queries.select { |query| query.model_name == "Post" }.size
+
+# None of the queries should be slower than 100ms
+assert queries.none? { |query| query.duration > 100 }
+
+# Fail on N+1 queries: expect no more than 1 query per table
+queries_by_model = queries.group_by(&:model_name)
+assert queries_by_model.none? { |model_name, queries| queries.count > 1 }
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sql/spy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sql_spy.rb

@@ -0,0 +1,48 @@
+module SqlSpy
+  Query = Struct.new(:name, :sql, :duration) do
+    def model_name
+      name.split.first
+    end
+
+    def select?
+      sql.starts_with?("SELECT")
+    end
+
+    def insert?
+      sql.starts_with?("INSERT")
+    end
+
+    def update?
+      sql.starts_with?("UPDATE")
+    end
+
+    def delete?
+      sql.starts_with?("DELETE")
+    end
+  end
+
+  class Tracker
+    IGNORED_NAMES = %w(SCHEMA)
+
+    def queries
+      @queries ||= []
+    end
+
+    def call(_name, start, finish, _message_id, values)
+      return if values[:name].nil? || IGNORED_NAMES.include?(values[:name])
+      return if values[:cached]
+
+      queries << Query.new(values[:name], values[:sql], (finish - start) * 1000)
+    end
+  end
+
+  def self.track
+    tracker = Tracker.new
+
+    ActiveSupport::Notifications.subscribe("sql.active_record", tracker)
+    yield
+    ActiveSupport::Notifications.unsubscribe(tracker)
+
+    tracker.queries
+  end
+end

data/sql-spy.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name = "sql_spy"
+  spec.version = "0.2.0"
+  spec.authors = ["Florin Lipan"]
+  spec.email = ["florinlipan@gmail.com"]
+
+  spec.summary = %q{A gem to track SQL queries triggered by a particular block of code}
+  spec.homepage = "https://github.com/lipanski/sql-spy"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lipanski/sql-spy"
+  spec.metadata["changelog_uri"] = "https://github.com/lipanski/sql-spy/releases"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: sql_spy
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Florin Lipan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- florinlipan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_spy.rb
+- sql-spy.gemspec
+homepage: https://github.com/lipanski/sql-spy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lipanski/sql-spy
+  source_code_uri: https://github.com/lipanski/sql-spy
+  changelog_uri: https://github.com/lipanski/sql-spy/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A gem to track SQL queries triggered by a particular block of code
+test_files: []