rspec-sqlimit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 475c6503c3977cff0ade02d623b23dfe2465b94f
-  data.tar.gz: 2d9f1030c97a6eb4d156d6a25ee38e46c44456ee
+  metadata.gz: fb112af9504128b90adde574c3ec62eb7853a35e
+  data.tar.gz: 5a7a2d7ed16fc1224168435263f27d59e943530d
 SHA512:
-  metadata.gz: c687ef9cb2d62c639cd924c90e6ee61417ddfe041e28f13c142b45e9ea35305d8d0f125c125c9d5cd6354dc937a0f9b8d3ab85414ddaaf79c1b3d0ff7a934b0b
-  data.tar.gz: 57a9ac1ed2e7a67f37def16516becfc1b38dfd403eccfe389f2e0b32498e446906f8d1ca8767823f8e3950892ed29a7385adc4d01c3251ecfda522ebe5772fb3
+  metadata.gz: 943305eafecad8557ed1ef7baaca8eb02ae9c2f05da61f538c6412fb49a568ac5df7e686c8455b47fc20d919ade80704d071e328197c51d54b96e6699d7b8b24
+  data.tar.gz: 8cede3b49a91a9ce2ab17869e94fa4a674c157ecd7043f73a95a0d25552fb51e63b4648a7cc2c2c1320642233f585234137a087ca71a2954f6c7c3b34a50af58

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/dummy/db/*.sqlite3

data/.travis.yml

@@ -3,7 +3,7 @@ sudo:     false
 language: ruby
 cache:    bundler
 script:
-  - bundle exec rspec
+  - bundle exec rake
 rvm:
   - 2.3.0
   - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.0.2] - [2017-05-17]
+
+### Added
+- All variables of SQL queries are bound to error messages (@Dobrodushny)
+
+## [0.0.1] - [2017-02-12]
+This is a first public release (@nepalez)
+
+[Unreleased]: https://github.com/tram-rb/tram-policy
+[0.0.1]: https://github.com/nepalez/rspec-sqlimit/releases/tag/v0.0.1
+[0.0.2]: https://github.com/nepalez/rspec-sqlimit/compare/v0.0.1...v0.0.2

data/README.md

@@ -4,6 +4,8 @@ RSpec matcher to control number of SQL queries executed by a block of code.
 
 It wraps [the answer at Stack Overflow][stack-answer] by [Ryan Bigg][ryan-bigg], which based on Active Support [Notification][notification] and [Instrumentation][instrumentation] mechanisms.
 
+For motivation and details see my [blog post "Fighting the Hydra of N+1 queries" in the Martian Chronicles][hydra].
+
 [![Gem Version][gem-badger]][gem]
 [![Build Status][travis-badger]][travis]
 [![Dependency Status][gemnasium-badger]][gemnasium]
@@ -66,31 +68,7 @@ require "rspec-sqlimit"
 
 RSpec.describe "N+1 safety" do
   it "doesn't send unnecessary requests to db" do
-    expect { User.create }.not_to exceed_query_limit(1).with(/^INSERT/)
-  end
-end
-```
-
-```
-Failure/Error: expect { User.create }.not_to exceed_query_limit(0).with(/INSERT/)
-
-  Expected to run maximum 0 queries that match (?-mix:INSERT)
-  The following 1 queries were invoked among others (see mark ->):
-     1) begin transaction (0.072 ms)
-  -> 2) INSERT INTO "users" DEFAULT VALUES (0.368 ms)
-     3) commit transaction (147.559 ms)
-```
-
-## Further Development
-
-For now the gem uses unbinded Active Record queries in error descriptions. For example, when your query contains arguments, the error message will look like
-
-```ruby
-require "rspec-sqlimit"
-
-RSpec.describe "N+1 safety" do
-  it "doesn't send unnecessary requests to db" do
-    expect { User.create(name: "Joe") }.not_to exceed_query_limit(1)
+    expect { User.create name: "Joe" }.not_to exceed_query_limit(1).with(/^INSERT/)
   end
 end
 ```
@@ -101,11 +79,11 @@ Failure/Error: expect { User.create }.not_to exceed_query_limit(0).with(/INSERT/
   Expected to run maximum 0 queries that match (?-mix:INSERT)
   The following 1 queries were invoked among others (see mark ->):
      1) begin transaction (0.072 ms)
-  -> 2) INSERT INTO "users" ("name") VALUES (?) (0.368 ms)
+  -> 2) INSERT INTO "users" ("name") VALUES (?); ["Joe"] (0.368 ms)
      3) commit transaction (147.559 ms)
 ```
 
-This is because [Active Record instrumentation hook][hook] keeps a query and bindings separately (under `:sql` and `:binds` keys). So the challenge is **to bind arguments to the query** in the report to make a debugging a bit simpler.
+In the last example you can see that binded values are shown after the query following the Rails convention.
 
 ## License
 
@@ -124,3 +102,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 [notification]: http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html
 [instrumentation]: http://guides.rubyonrails.org/active_support_instrumentation.html
 [hook]: http://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record
+[hydra]: https://evilmartians.com/chronicles/fighting-the-hydra-of-n-plus-one-queries

data/Rakefile

@@ -8,6 +8,6 @@ load "spec/dummy/Rakefile"
 
 # Declares gem's own tasks.
 desc "Runs test suite."
-task default: %w(dummy:db:migrate) do
+task default: %w(dummy:db:create dummy:db:migrate) do
   system "bundle exec rspec spec"
 end

data/lib/rspec/sqlimit/counter.rb

@@ -31,7 +31,11 @@ module RSpec::SQLimit
     def callback
       @callback ||= lambda do |_name, start, finish, _message_id, values|
         return if %w(CACHE SCHEMA).include? values[:name]
-        queries << { sql: values[:sql], duration: (finish - start) * 1_000 }
+        queries << {
+          sql: values[:sql],
+          duration: (finish - start) * 1_000,
+          binds: values[:type_casted_binds]
+        }
       end
     end
   end

data/lib/rspec/sqlimit/reporter.rb

@@ -28,7 +28,8 @@ module RSpec::SQLimit
 
     def line(query, index)
       prefix = (matcher && query[:sql] =~ matcher) ? "->" : "  "
-      "#{prefix} #{index + 1}) #{query[:sql]} (#{query[:duration].round(3)} ms)"
+      binds = query[:binds].any? ? "; #{query[:binds]} " : ''
+      "#{prefix} #{index + 1}) #{query[:sql]}#{binds} (#{query[:duration].round(3)} ms)"
     end
   end
 end

data/rspec-sqlimit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = "rspec-sqlimit"
-  gem.version     = "0.0.1"
+  gem.version     = "0.0.2"
   gem.author      = "Andrew Kozin (nepalez)"
   gem.email       = "andrew.kozin@gmail.com"
   gem.homepage    = "https://github.com/nepalez/rspec-sqlimit"

data/spec/dummy/db/migrate/20170211104800_create_users.rb

@@ -1,4 +1,4 @@
-class CreateUsers < ActiveRecord::Migration
+class CreateUsers < ActiveRecord::Migration[4.2]
   def change
     create_table :users
   end

data/spec/rspec/sqlimit/reporter_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe RSpec::SQLimit::Reporter do
+  subject { described_class.new(counter) }
+
+  context 'no params were passed to the query' do
+    let(:counter) { RSpec::SQLimit::Counter[/CREATE/, Proc.new{ User.create }] }
+
+    it "doesn't print binds" do
+      # INSERT INTO "users" DEFAULT VALUES (0.284 ms)
+      expect(subject.call).to include("DEFAULT VALUES")
+    end
+  end
+
+  context 'query contains params' do
+    context 'nil was passed as param' do
+      let(:counter) { RSpec::SQLimit::Counter[/CREATE/, Proc.new{ User.create(id: nil) }] }
+
+      it "doesn't print binds" do
+        # INSERT INTO "users" DEFAULT VALUES (0.284 ms)
+        expect(subject.call).to include("DEFAULT VALUES")
+      end
+    end
+
+    context 'single param was passed' do
+      let(:counter) { RSpec::SQLimit::Counter[/CREATE/, Proc.new{ User.create(id: 1) }] }
+
+      it 'prints param as an array with one element' do
+        # INSERT INTO "users" ("id") VALUES (?); [1]  (0.234 ms)
+        expect(subject.call).to include("VALUES (?); [1]")
+      end
+    end
+
+    context 'array was passed as a param' do
+      let(:counter) { RSpec::SQLimit::Counter[/SELECT/, Proc.new{ User.where(id: [1, 2, 3]).to_a }] }
+
+      it 'prints all params' do
+        # SELECT "users".* FROM "users" WHERE "users"."id" IN (1, 2, 3) (0.17 ms))
+        expect(subject.call).to include("IN (1, 2, 3)")
+      end
+    end
+  end
+end

data/spec/rspec/sqlimit_spec.rb

@@ -6,6 +6,14 @@ describe "exceed_query_limit" do
       expect { User.new }.not_to exceed_query_limit(0)
     end
 
+    it "works when nil is used as a parameter" do
+      expect { User.create id: nil }.to exceed_query_limit(0)
+    end
+
+    it "works when array is used as a restriction" do
+      expect { (User.where id: [1, 2, 3]).to_a }.to exceed_query_limit(0)
+    end
+
     it "works when actual number of queries is below the limit" do
       expect { User.create }.not_to exceed_query_limit(3)
     end
@@ -20,6 +28,14 @@ describe "exceed_query_limit" do
       expect { User.new }.not_to exceed_query_limit(0).with(/INSERT/)
     end
 
+    it "works when nil is used as a parameter" do
+      expect { User.create id: nil }.to exceed_query_limit(0).with(/INSERT/)
+    end
+
+    it "works when array is used as a restriction" do
+      expect { (User.where id: [1, 2, 3]).to_a }.to exceed_query_limit(0).with(/SELECT/)
+    end
+
     it "works when actual number of queries is below the limit" do
       expect { User.create }.not_to exceed_query_limit(1).with(/INSERT/)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sqlimit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,12 +120,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,9 +143,9 @@ files:
 - spec/dummy/config/environment.rb
 - spec/dummy/db/migrate/20170211104800_create_users.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
 - spec/dummy/lib/dummy.rb
 - spec/dummy/lib/dummy/application.rb
+- spec/rspec/sqlimit/reporter_spec.rb
 - spec/rspec/sqlimit_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nepalez/rspec-sqlimit
@@ -177,8 +179,8 @@ test_files:
 - spec/dummy/config/environment.rb
 - spec/dummy/db/migrate/20170211104800_create_users.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
 - spec/dummy/lib/dummy.rb
 - spec/dummy/lib/dummy/application.rb
+- spec/rspec/sqlimit/reporter_spec.rb
 - spec/rspec/sqlimit_spec.rb
 - spec/spec_helper.rb