ar-query-matchers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5265f76d235538ee76fd8ed78d460357bd35efc1b9f96286cd674c646dfa9080
-  data.tar.gz: 368284e4b46d07c1331805e1224f15f66f82757a69dcc2d2eccb097331e154e9
+  metadata.gz: 60c088b5a136a27e7cda68a413f8a46005c82f63ff30bb22eaadf70995390755
+  data.tar.gz: 2be1beb74c5716601305bd6771fb2f9ba8058879a609dcb4198c640a1a5f7cd9
 SHA512:
-  metadata.gz: 6b6f19694c17e3462faccfcb5928e907a269947264f2a9902d7bcfb4a5ea0c88aeb99deff97198abbe5f42d25d6f844dcdff738967ef783e6a1230cadb3ce0aa
-  data.tar.gz: 55615a4c940d4dfdfbba8625fea16bcc64c537e31c31f690fc7fcc1d2b3ca7a775d5b68e145e472a478b0c8a787239fdc3c2cb8d42fbf66fcf581231499b4131
+  metadata.gz: 24c9812af618e31c66520d52d79e6a7bf0b6695c8e99323136877061bcac6045f795bc4655af35d9aeca49bd2ed129b0227bc717544e4c5007df1493fb9fa65c
+  data.tar.gz: c6905a488bde5a20cd45cb636d59d9c0dcf2b459cbafda156da918a0fa4a71866b60ee014ede6ec242539ced60f6915ccbecb56848b411bda97ca8d6eb0b4a5f

data/CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.3.0] - 2020-03-13
+
+- Correct the Rails dependency to allow for Rails 6.0
 
 ## [0.2.0] - 2019-09-15
 ### Changed
@@ -17,4 +20,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]: https://github.com/gusto/ar-query-matchers/compare/v0.2.0...HEAD
 [0.2.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.2.0
-[0.1.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.1.0
+[0.1.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.1.0

data/README.md

@@ -1,25 +1,28 @@
 ## AR Query Matchers
 ![badge](https://action-badges.now.sh/gusto/ar-query-matchers?action=Run%20Tests)
 
-These RSpec matchers allows guarding against N+1 queries by specifying
+These RSpec matchers allow guarding against N+1 queries by specifying
 exactly how many queries you expect each of your ActiveRecord models to perform.
 
-They also help us reason about the type of record interactions happening in a block of code.
+They could also help reasoning about which database interactions are happening inside a block of code.
 
 This pattern is a based on how Rails itself tests queries:
 https://github.com/rails/rails/blob/ac2bc00482c1cf47a57477edb6ab1426a3ba593c/activerecord/test/cases/test_case.rb#L104-L141
 
+Currently, this gem only supports RSpec matchers, but the code is meant to be adapted to support other testing frameworks.
+If you'd like to pick that up, please have a look at: https://github.com/Gusto/ar-query-matchers/issues/13
+
 ### Usage
 Include it in your Gemfile:
 ```ruby
 group :test do
-  gem 'ar-query-matchers', '~> 0.1.0', require: false
+  gem 'ar-query-matchers', '~> 0.2.0', require: false
 end
 ```
 
 Start using it: 
 ```ruby
-require 'ar-query-matchers'
+require 'ar_query_matchers'
 
 RSpec.describe Employee do
   it 'creating an employee creates exactly one record' do
@@ -31,7 +34,7 @@ end
 ```
 
 ### Matchers
-This module defines a few categories of matchers:
+This gem defines a few categories of matchers:
 - **Create**: Which models are created during a block
 - **Load**: Which models are fetched during a block
 - **Update**: Which models are updated during a block
@@ -55,7 +58,7 @@ expect { some_code() }.to only_load_models(
 )
 ```
 
-The following spec will pass only if there are exactly no select queries.
+The following spec will pass only if there are no select queries.
 ```ruby
 expect { some_code() }.to not_load_models
 ```
@@ -84,11 +87,9 @@ Expected to run queries to load models exactly {"Address"=>1, "Payroll"=>1, "Use
 ```
 
 ### High Level Design:
-The RSpec matcher delegates to the query counters, asserts expectations and formats error messages to provide meaningful failures.  
- 
- 
+The RSpec matcher delegates to "query counters", asserts expectations and formats error messages to provide meaningful failures.  
 The matchers are pretty simple, and delegate instrumentation into specialized QueryCounter classes.
-The QueryCounters are different classes instruments a ruby block by listening on all sql, parsing the queries and returning structured data describing the interactions.
+The QueryCounters are different classes which instrument a ruby block by listening on all sql, parsing the queries and returning structured data describing the interactions.
 
 ```                
   ┌────────────────────────────────────────────────────────────────────────────────────────┐

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-15 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: These RSpec matchers allows guarding against N+1 queries by specifying
+description: These RSpec matchers allow guarding against N+1 queries by specifying
   exactly how many queries you expect each of your ActiveRecord models to perform.
 email:
 - mzruya@gmail.com