query_cop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f484f6410454ce2cc837eb9123258f49c50fdcbb4655075231badff454cec540
-  data.tar.gz: bdca8d9d60a128a1bdc8725336c1d9813397e98f4239e46ac0532bd986cfe399
+  metadata.gz: 6bd5d454c419341517523f0bca996b173c38ea9dc11d9ff1c190bd0c0b9166a9
+  data.tar.gz: 6dd0f4c6e5538efd28b8a811e70a7261deac54b887739828dcd47e221dfd21ee
 SHA512:
-  metadata.gz: dd6f4621989e2dbafdb5cee5a47004ecf4d2b808e6409167c49eb9b8317b5f8e528caab247ba48239999a8bcd513e4667387c2ad24f43712ef6fd1f21a6950e2
-  data.tar.gz: 59c4d295e5d99a4ed8a9e708ab97eb9141086611946127272639f223e9ba9a3a0d478ae279ba18734a1d2563ce998bfba19b29f36fe93ee84dff7445b8731308
+  metadata.gz: d84c696db0328f3b3a4217301b1647eea269462661652f3ad65e78b5711e4e3ff18b4dbc573cc85e04f0c43af34e00b4c973ee2492f5e30fed129f595666c0af
+  data.tar.gz: 28441cc83f21b47cfb3f711dbcb0ff5ad6fa00f198bcca8f1c974f3c37ef41483fdbee2007d733df6eb9142b10d4b0c83fb0a1db2ac682e79be0ed7621871bff

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.AppleDouble
+.LSOverride

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    query_cop (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  query_cop!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,5 +1,13 @@
 # QueryCop
 
+# Description
+
+A query tracker for ActiveRecord and Rspec that helps Rails developers be aware of how many database lookups their code is generating.
+
+By setting the maximum allowed query count in the test, it also helps the query count become explicit and have more robust performance-aware regression tests.
+
+The gem currently only works with sqlite3, psql and mysql.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +26,7 @@ Or install it yourself as:
 
 ## Usage
 
-This gem currently works with only Rspec.
+
 In any of your rspec examples, you can add
 ```
    with_allowed_max_query_count(#{max_allowed_query_count}) do
@@ -42,6 +50,8 @@ Failure/Error:
              SELECT "license_plates".* FROM "license_plates" WHERE "license_plates"."car_id" = $1
 ```
 
+Within the `with_allowed_max_query_count` block, you can also directly access the current list of queries by calling `QueryCop::QueryTracker.queries`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/query_cop.rb

@@ -1,6 +1,6 @@
 require_relative "query_cop/query_tracker"
-require "query_cop/active_record_adapter"
-require "query_cop/rspec_helper"
+require_relative "query_cop/active_record_adapter"
+require_relative "query_cop/rspec_helper"
 
 ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:prepend, QueryCop::ActiveRecordAdapter) if Rails.env.test?
 

data/lib/query_cop/active_record_adapter.rb

@@ -1,4 +1,5 @@
 require_relative "query_tracker.rb"
+
 module QueryCop
   module ActiveRecordAdapter
     def log(query, *)

data/lib/query_cop/query_tracker.rb

@@ -1,27 +1,50 @@
 module QueryCop
   class QueryTracker
     class << self
-      attr_accessor :queries
+      attr_accessor :queries, :enabled
 
       def reset
         self.queries = []
       end
 
+      def enable
+        self.enabled = true
+      end
+
+      def disable
+        self.enabled = false
+      end
+
       def track(log)
-        queries.push(log) if query?(log)
+        queries.push(log) if query?(log) && enabled?
       end
 
       def query_count
         queries.size
       end
 
+      def clean_wrap
+        enable
+        reset
+
+        yield
+
+        reset
+        disable
+      end
+
       private
 
       def query?(log)
         log =~ /^(select|create|update|delete|insert)\b/i
       end
+
+      def enabled?
+        enabled == true
+      end
     end
 
     reset
+    disable
   end
 end

data/lib/query_cop/rspec_helper.rb

@@ -3,18 +3,19 @@ require_relative "active_record_adapter.rb"
 module QueryCop
   module RspecHelper
     def with_allowed_max_query_count(max_count)
-      QueryCop::QueryTracker.reset
+      QueryTracker.clean_wrap do
 
-      yield
+        yield
 
-      failure_message = <<-EOS
-      Allowed maximum query count: #{max_count}
-      Actual generated query count: #{QueryCop::QueryTracker.query_count}
-      Here is the list of generated queries:
-      #{QueryCop::QueryTracker.queries.join("\n")}
-      EOS
+        failure_message = <<-EOS
+        Allowed maximum query count: #{max_count}
+        Actual generated query count: #{QueryTracker.query_count}
+        Here is the list of generated queries:
+        #{QueryTracker.queries.join("\n")}
+        EOS
 
-      expect(QueryCop::QueryTracker.query_count).to be < max_count, failure_message
+        expect(QueryTracker.query_count).to be <= max_count, failure_message
+      end
     end
   end
 end

data/lib/query_cop/version.rb

@@ -1,3 +1,3 @@
 module QueryCop
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_cop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wai Phyo Maung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-19 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,15 +46,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/.DS_Store
 - lib/query_cop.rb
 - lib/query_cop/active_record_adapter.rb
 - lib/query_cop/query_tracker.rb