rspec-sql 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 604f3e80d1493fef761a5cd6c4cc1f2b16ddeaea989fd06a52f6e5266c30a015
-  data.tar.gz: caf7ab6da1bb00e2c49fae1be3ca2ed8c787adab7f3983e02ac0972f410f1140
+  metadata.gz: 9cfbb9dfa6686fc934767248d98c65a3ffa0647f9674df74792ab344109b2899
+  data.tar.gz: 576dce207bae8bdb03585dc0234a898bf12d4b8e9e27f22f55817ce03babb4d8
 SHA512:
-  metadata.gz: fecdb314d1af946b4c1d37807f25ece49c3d0ce2a969984c7d8ac9ec325afee4359021e3623792a85085c0c77e17f1510b568f7d43733eb0a12ee6151cf4e1bb
-  data.tar.gz: 01afcbf7343a73735ade838e1b0c1991cd8d4b62d9d38a9e75fc5c66b34c3d1fd34b38b8a97d3ddb9b297781624237e250e1775012f2e2cb4451240d62e90a14
+  metadata.gz: 8d50829389362c678403a0ddaf982e44232aa2b884159f8928f07943b351ca00b015d48854e953f977ac6f5f3eefd6e47b168e2c732311e7187f677e97753ed5
+  data.tar.gz: aff99ef38190a45774eb0ada50daaba8f9182d2f89f3ebcdfb35ed3781210b4e19941b3bedcc5ef736c186474c6ccec41bd0c9149918e38c1c773087a3b9673d

data/lib/rspec/sql/query_matcher.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "query_summary"
+
+module RSpec
+  module Sql
+    # Compares expectations with actual queries.
+    class QueryMatcher
+      attr_reader :expected
+
+      def initialize(queries, expected)
+        @queries = queries
+        @expected = sanitize_number(expected)
+      end
+
+      def matches?
+        # Simple presence validation.
+        return !@queries.empty? if expected.nil?
+
+        actual == expected
+      end
+
+      def actual
+        @actual ||= actual_compared_to_expected
+      end
+
+      private
+
+      # Support writing: `is_expected.to query_database 5.times`
+      def sanitize_number(expected)
+        if expected.is_a?(Enumerator) && expected.inspect.match?(/:times>$/)
+          expected.size
+        else
+          expected
+        end
+      end
+
+      def actual_compared_to_expected
+        case expected
+        when Integer
+          @queries.size
+        when Array
+          query_names
+        when Hash
+          query_summary
+        else
+          raise "What are you expecting?"
+        end
+      end
+
+      def query_names
+        @queries.map { |q| q[:name] || q[:sql].split.take(2).join(" ") }
+      end
+
+      def query_summary
+        QuerySummary.new(@queries).summary
+      end
+    end
+  end
+end

data/lib/rspec/sql/query_summary.rb

@@ -2,8 +2,9 @@
 
 module RSpec
   module Sql
+    # Converts a list of queries into a summary hash.
     class QuerySummary
-      QUERY_TYPES = [:delete, :insert, :select, :update].freeze
+      QUERY_TYPES = %i[delete insert select update].freeze
 
       attr_reader :summary
 

data/lib/rspec/sql.rb

@@ -3,36 +3,33 @@
 require "active_support"
 require "rspec"
 
-require_relative "sql/query_summary"
+require_relative "sql/query_matcher"
 
+# We are building within the RSpec namespace for consistency and convenience.
+# We are not part of the RSpec team though.
 module RSpec
+  # RSpec::Sql contains our code.
   module Sql; end
 
-  RSpec::Matchers.define :query_database do |expected = nil|
+  Matchers.define :query_database do |expected = nil|
     match do |block|
       @queries = scribe_queries(&block)
+      @matcher = Sql::QueryMatcher.new(@queries, expected)
+      expected = matcher.expected
 
-      if expected.nil?
-        !@queries.empty?
-      elsif expected.is_a?(Integer)
-        @queries.size == expected
-      elsif expected.is_a?(Enumerator) && expected.inspect.match?(/:times>$/)
-        @queries.size == expected.size
-      elsif expected.is_a?(Array)
-        query_names == expected
-      elsif expected.is_a?(Hash)
-        query_summary == expected
-      else
-        raise "What are you expecting?"
-      end
+      matcher.matches?
     end
 
     failure_message do |_block|
+      if expected.nil?
+        return "Expected at least one database query but observed none."
+      end
+
       <<~MESSAGE
         Expected database queries: #{expected}
-        Actual database queries:   #{query_names}
+        Actual database queries:   #{matcher.actual}
 
-        Diff: #{Expectations.differ.diff_as_object(query_names, expected)}
+        Diff: #{diff(matcher.actual, expected)}
 
         Full query log:
 
@@ -41,31 +38,40 @@ module RSpec
     end
 
     failure_message_when_negated do |_block|
-      "Expected no database queries but observed:\n\n#{query_descriptions.join("\n")}"
+      <<~TXT
+        Expected no database queries but observed:
+
+        #{query_descriptions.join("\n")}
+      TXT
     end
 
     def supports_block_expectations?
       true
     end
 
-    def query_names
-      @queries.map { |q| q[:name] || q[:sql].split.take(2).join(" ") }
-    end
-
     def query_descriptions
       @queries.map { |q| "#{q[:name]}  #{q[:sql]}" }
     end
 
-    def query_summary
-      Sql::QuerySummary.new(@queries).summary
+    def matcher
+      @matcher
+    end
+
+    def diff(actual, expected)
+      if expected.is_a?(Numeric)
+        change = actual - expected
+        format("%+d", change)
+      else
+        Expectations.differ.diff_as_object(actual, expected)
+      end
     end
 
     def scribe_queries(&)
       queries = []
 
-      logger = ->(_name, _started, _finished, _unique_id, payload) {
+      logger = lambda do |_name, _started, _finished, _unique_id, payload|
         queries << payload unless %w[CACHE SCHEMA].include?(payload[:name])
-      }
+      end
 
       ActiveSupport::Notifications.subscribed(logger, "sql.active_record", &)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Maikel Linke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,11 +46,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rspec/sql.rb
+- lib/rspec/sql/query_matcher.rb
 - lib/rspec/sql/query_summary.rb
 homepage: https://github.com/openfoodfoundation/rspec-sql
 licenses:
 - AGPL-3.0-or-later
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/openfoodfoundation/rspec-sql/releases
+  source_code_uri: https://github.com/openfoodfoundation/rspec-sql/
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: