db-query-matchers 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65befe1a407bc1dd9428fe80524abdc717de779d
-  data.tar.gz: ed7a5d7eb22679bb5318991bf70c06f49fca653e
+  metadata.gz: fc48c9f7dac8104c00663ade64d3dba62487e682
+  data.tar.gz: d6813610637b71bfa53435f8fc3f45e58470a6b2
 SHA512:
-  metadata.gz: 68a653eaa1cc7782db59b75f8779a038060e6086a6959464d05cfa35870b4a99ab57e904f91e1bdd782cffcd30c27dcf473a98c787db7e1eef6df70e6baf7bed
-  data.tar.gz: 18093d3257903cdb7346e53cda23a79110b11ada6d04292163f757d27a62f0a5a2b7ca6bbbee48e337c016221b07c374276d490fdae9e423e6adc5daa2e7f25a
+  metadata.gz: 0b836ebccfaeb3b302cf75768c25dadefcd7e6988435cd81e7c510536e1909aed2a55fb0d6b49005fc81cdd4e8e3990f34931d9c7a8465b990faedae865c2583
+  data.tar.gz: aae4118888524878f5793fe2d760a7a8d9c025e8b7859235a0c8349e866250b2d2810cbf8acda815e982c7c523822086d2b504b65c678d236671438da1629e98

data/lib/db_query_matchers/make_database_queries.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+
+# Custom matcher to check for database queries performed by a block of code.
+#
+# @example
+#   expect { subject }.to_not make_database_queries
+#
+# @example
+#   expect { subject }.to make_database_queries(count: 1)
+#
+# @see QueryCounter
+RSpec::Matchers.define :make_database_queries do |options = {}|
+
+  # Taken from ActionView::Helpers::TextHelper
+  def pluralize(count, singular, plural = nil)
+    word = if count == 1 || count =~ /^1(\.0+)?$/
+             singular
+           else
+             plural || singular.pluralize
+           end
+
+    "#{count || 0} #{word}"
+  end
+
+  match do |block|
+    @counter = QueryCounter.new
+    ActiveSupport::Notifications.subscribed(@counter.to_proc,
+                                            'sql.active_record',
+                                            &block)
+    if absolute_count = options[:count]
+      @counter.count == absolute_count
+    else
+      @counter.count > 0
+    end
+  end
+
+  failure_message_for_should_not do |_|
+    <<-EOS
+      expected no queries, but #{@counter.count} were made:
+      #{@counter.log.join("\n")}
+    EOS
+  end
+
+  failure_message_for_should do |_|
+    if options[:count]
+      expected = pluralize(options[:count], 'query')
+      actual   = pluralize(@counter.count, 'was', 'were')
+
+      output   = "expected #{expected}, but #{actual} made"
+      if @counter.count > 0
+        output += ":\n#{@counter.log.join("\n")}"
+      end
+      output
+    else
+      'expected queries, but none were made'
+    end
+  end
+end

data/lib/db_query_matchers/query_counter.rb

@@ -0,0 +1,43 @@
+# Counter to keep track of the number of queries caused by running a piece of
+# code. Closely tied to the `:make_database_queries` matcher, this class is
+# designed to be a consumer of `sql.active_record` events.
+#
+# @example
+#   counter = QueryCounter.new
+#   ActiveSupport::Notifications.subscribed(counter.to_proc,
+#                                          'sql.active_record') do
+#     # run code here
+#   end
+#   puts counter.count          # prints the number of queries made
+#   puts counter.log.join(', ') # prints all queries made
+#
+# @see http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html#module-ActiveSupport::Notifications-label-Temporary+Subscriptions
+class QueryCounter
+  attr_reader :count, :log
+
+  def initialize
+    @count = 0
+    @log   = []
+  end
+
+  # Turns a QueryCounter instance into a lambda. Designed to be used when
+  # subscribing to events through the ActiveSupport::Notifications module.
+  #
+  # @return [Proc]
+  def to_proc
+    lambda(&method(:callback))
+  end
+
+  # Method called from the ActiveSupport::Notifications module (through the
+  # lambda created by `to_proc`) when an SQL query is made.
+  #
+  # @param name       [String] name of the event
+  # @param start      [Time]   when the instrumented block started execution
+  # @param finish     [Time]   when the instrumented block ended execution
+  # @param message_id [String] unique ID for this notification
+  # @param payload    [Hash]   the payload
+  def callback(name, start, finish, message_id, payload)
+    @count += 1
+    @log << payload[:sql]
+  end
+end

data/lib/db_query_matchers/version.rb

@@ -0,0 +1,4 @@
+# Defines the gem version.
+module DBQueryMatchers
+  VERSION = '0.1.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Causes Engineering
@@ -78,6 +78,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/db_query_matchers.rb
+- lib/db_query_matchers/version.rb
+- lib/db_query_matchers/make_database_queries.rb
+- lib/db_query_matchers/query_counter.rb
 homepage: https://github.com/causes/db-query-matchers
 licenses:
 - MIT