rspec-activerecord-expectations 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed8bce8c2576663b3d187efc7ae064c239c9ab8f3e6dacae592563ea4c484fb
-  data.tar.gz: 9e67c875fd8dcab13a8e0ed56b34f842519f1af4f0037f5c8955970cc82f2850
+  metadata.gz: ea0eb161965acaf677cec0de83466eece5379423903fc0a04b181cabe61a8121
+  data.tar.gz: 4df14e9211baf4ac6f3935a68b910191480f6f6af622f36c7d7e51a90374d222
 SHA512:
-  metadata.gz: 0ea389afd2110fbaca8c2215507874e1fed2ad1e1f5dae167baaf532d56f91bcfa3f7458a88a71e6ce2de341160ba0fe3f3a25c786641204ebda1f3fe2db707c
-  data.tar.gz: 9ace14690c79ee0ca1e5c9a3841a9769d58b315685e811b253d393c2a5858294153cf1b0e88471b584112391b351173163cd4d6326920654e35d3aac83c6cf77
+  metadata.gz: 75bd827d5d0fc6566ba54f48cd432fab6cad301f2b5eb781383ea227ec74e2699733026fc22086899ac8bf725280e9cb1a5d7ca42545074cee1eb932142f9d93
+  data.tar.gz: ad9f387210fb8d30c06b5177a51b934a415d36805d94729d8117408200b241ee3f9408884bfbe63ab2bc93b28118f69a13dbe1aa05e3a2eb80bf04705a6b3de4

data/.github/workflows/main.yml

@@ -15,7 +15,7 @@ jobs:
         rails: ['5.0', '5.1', '5.2', '6.0', '6.1', '7.0']
 
     runs-on: ${{ matrix.os }}
-    name: Test ruby ${{ matrix.ruby_version }} / rails ${{ matrix.rails }} / ${{ matrix.os }}
+    name: ruby ${{ matrix.ruby_version }}, rails ${{ matrix.rails }}, ${{ matrix.os }}
 
     steps:
       - uses: actions/checkout@v2
@@ -26,7 +26,7 @@ jobs:
           ruby_version: ${{ matrix.ruby_version }}
           bundler-cache: true
 
-      - name: Install correct gems / rails version
+      - name: Install Gems w/ Rails ${{ matrix.rails }}
         env:
           MATRIX_RAILS_VERSION: ${{ matrix.rails }}
         run: |
@@ -40,12 +40,11 @@ jobs:
   test_legacy:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
         ruby_version: ['2.6', '2.5', '2.4', '2.3']
         rails: ['5.0', '5.1', '5.2']
 
-    runs-on: ${{ matrix.os }}
-    name: Test Legacy ruby ${{ matrix.ruby }} / rails ${{ matrix.rails }} / ${{ matrix.os }}
+    runs-on: ubuntu-latest
+    name: legacy ruby ${{ matrix.ruby_version }}, rails ${{ matrix.rails }}
 
     steps:
       - uses: actions/checkout@v2
@@ -56,7 +55,7 @@ jobs:
           ruby_version: ${{ matrix.ruby_version }}
           bundler-cache: true
 
-      - name: Install correct gems / rails version
+      - name: Install Gems w/ Rails ${{ matrix.rails }}
         env:
           MATRIX_RAILS_VERSION: ${{ matrix.rails }}
         run: |

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Changelog
 
+## [1.2.0] - 2020-12-31
+- Add `query` as a synonym for `queries`
+- Ignore schema and transaction queries in query count
+- Add beginning of recording specific query types
+- Add query count matcher for `exactly`
+
 ## [1.1.0] - 2020-12-30
-- Add matchers for less_than_or_equal_to, greater_than
+- Add query count matchers for e.g. `less_than_or_equal_to`, `greater_than`
 
 ## [1.0.1] - 2020-12-30
 - Pin all the dependencies to a proper working subset

data/README.md

@@ -91,9 +91,12 @@ That's it! Refactor your report to be more efficient and then leave the test in
 place to make sure that future developers don't accidentally cause a
 performance regression.
 
-## Supported Matchers
+## Counting Queries
 
-Listed along with their aliases.
+### Types of Comparisons
+
+Several comparison types are available, along with some aliases to allow for
+easier to read tests.
 
 ```ruby
 expect {}.to execute.less_than(20).queries
@@ -107,6 +110,25 @@ expect {}.to execute.more_than(20).queries
 
 expect {}.to execute.greater_than_or_equal_to(20).queries
 expect {}.to execute.at_least(20).queries
+
+expect {}.to execute.exactly(20).queries
+
+expect {}.to execute.at_least(2).queries
+expect {}.to execute.at_least(1).query # singular form also accepted
+```
+
+### Specific Query Types
+
+You can of course make assertions for the total number of queries executed, but
+sometimes it's more valuable to assert particular _types_ of queries, such as
+inserts or find statements. Matchers are supported for this as well!
+
+**Note**: Transaction (for example, `ROLLBACK`) queries are not counted in any of these
+categories, nor are queries that load the DB schema.
+
+```ruby
+expect {}.to execute.exactly(20).queries
+expect {}.to execute.exactly(20).insert_queries
 ```
 
 ## Future Planned Functionality
@@ -114,10 +136,7 @@ expect {}.to execute.at_least(20).queries
 This gem still has lots of future functionality. See below.
 
 ```ruby
-expect {}.to execute.exactly(5).queries
-
 expect {}.to execute.at_least(2).activerecord_queries
-expect {}.to execute.at_least(2).insert_queries
 expect {}.to execute.at_least(2).delete_queries
 expect {}.to execute.at_least(2).load_queries
 expect {}.to execute.at_least(2).schema_queries
@@ -135,15 +154,11 @@ expect {}.to update.exactly(2).of_any_type
 expect {}.to delete.exactly(2).of_any_type
 
 expect {}.not_to repeatedly_load(Audited::Audit)
-
-expect {}.to execute.at_least(1).query
 ```
 
-- ignore transactionals (begin / rollback)
-- `name: Foo Load`
 - differentiate AR queries from generic ones? arbitrary execution somehow?
 - warn about warmup
-- make sure we don't smite any built in methods (or from other libs)
+- warn if we smite any built in methods (or methods from other libs)
 
 ## Development
 

data/lib/rspec/activerecord/expectations/collector.rb

@@ -1,15 +1,16 @@
 module RSpec::ActiveRecord::Expectations
   class Collector
     def initialize
-      @counts = {
-        queries: 0
-      }
+      @inspector  = QueryInspector.new
+      @counts     = QueryInspector.valid_query_types.each_with_object({}) do |query_type, hash|
+        hash[query_type] = 0
+      end
 
       ActiveSupport::Notifications.subscribe("sql.active_record", method(:record_query))
     end
 
     def queries_of_type(type)
-      @counts.fetch(type)
+      @counts[type] || (raise ArgumentError, "Sorry, #{type} is not a valid kind of query")
     end
 
     def valid_type?(type)
@@ -17,7 +18,10 @@ module RSpec::ActiveRecord::Expectations
     end
 
     def record_query(*_unused, data)
-      @counts[:queries] += 1
+      categories = @inspector.categorize(data)
+      categories.each do |category|
+        @counts[category] += 1
+      end
     end
   end
 end

data/lib/rspec/activerecord/expectations/matchers/query_count.rb

@@ -54,13 +54,24 @@ module RSpec::ActiveRecord::Expectations
       end
       alias_method :at_least, :greater_than_or_equal_to
 
+      def exactly(n)
+        @comparison   = n
+        @match_method = method(:compare_exactly)
+        self
+      end
+
       # TARGET QUERY TYPES
 
-      def queries
-        @query_type = :queries
-        self
+      RSpec::ActiveRecord::Expectations::QueryInspector.valid_query_types.each do |type|
+        define_method type do
+          @query_type = type
+          self
+        end
       end
 
+      # TODO singularize everything
+      alias_method :query, :queries
+
       private
 
       # MATCHERS
@@ -102,6 +113,15 @@ module RSpec::ActiveRecord::Expectations
 
         count >= @comparison
       end
+
+      def compare_exactly
+        count = @collector.queries_of_type(@query_type)
+
+        @failure_message = "expected block to execute at #{@comparison} queries, but it executed #{count}"
+        @failure_message_when_negated = "expected block not to execute #{@comparison} queries, but it executed #{count}"
+
+        count == @comparison
+      end
     end
   end
 end

data/lib/rspec/activerecord/expectations/query_inspector.rb

@@ -0,0 +1,19 @@
+module RSpec::ActiveRecord::Expectations
+  class QueryInspector
+    def self.valid_query_types
+      [:queries, :schema_queries, :transaction_queries, :insert_queries]
+    end
+
+    def categorize(query)
+      if query[:name] == "SCHEMA"
+        [:schema_queries]
+      elsif query[:name] == "TRANSACTION"
+        [:transaction_queries]
+      elsif query[:name] =~ /Create$/
+        [:queries, :insert_queries]
+      else
+        [:queries]
+      end
+    end
+  end
+end

data/lib/rspec/activerecord/expectations.rb

@@ -9,5 +9,6 @@ module RSpec
 end
 
 require_relative 'expectations/errors'
+require_relative 'expectations/query_inspector'
 require_relative 'expectations/collector'
 require_relative 'expectations/matchers/query_count'

data/rspec-activerecord-expectations.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rspec-activerecord-expectations"
-  spec.version       = '1.1.0'
+  spec.version       = '1.2.0'
   spec.authors       = ["Joseph Mastey"]
   spec.email         = ["hello@joemastey.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activerecord-expectations
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -103,6 +103,7 @@ files:
 - lib/rspec/activerecord/expectations/collector.rb
 - lib/rspec/activerecord/expectations/errors.rb
 - lib/rspec/activerecord/expectations/matchers/query_count.rb
+- lib/rspec/activerecord/expectations/query_inspector.rb
 - rspec-activerecord-expectations.gemspec
 homepage: https://github.com/jmmastey/rspec-activerecord-expectations
 licenses: