db-query-matchers 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ee8041578d3286a7bd09fc7f2aba92c797aeb6f
-  data.tar.gz: 08cd262fd6ee889e0db92fb9bc8347c3b5f23864
+  metadata.gz: 4211e9d9ce47b20a844dd9609372ba7f75aa6072
+  data.tar.gz: a1edf04492e31903f92813058cb8ce4fe68b9568
 SHA512:
-  metadata.gz: 2b6e5c04b7f43ac11bbd84290087031bab478fdb00e24b248dfa77f81b2495d92a17bb7246c1bb25d6a680cf19371f3547b9ea73312188ec27333c3ff8fbb329
-  data.tar.gz: 122b88bf16eee4bf4502f4216c323dc833a182b110a3f08674a47f34573952ff5435de814bada2d4c44d4cbfd5ab11e2509fe51e0d366d8d9a1b5b18f06a5fdd
+  metadata.gz: 00d22a2caf4c12a289c904f70765dc698c6d489c9ac5f27453d7e91b7fa84e1c2a8178a050cccc524b52117acd9321748e08cc48d2bf7571815293a1e7afad57
+  data.tar.gz: 340c16be98d92f6f29251a699407f16d6c3f9da0aab50377964cd1201563846c102e75c7973a473b3981649cdb0a6432bfcb73c4852adb05e120c8f8c1e29681

data/lib/db_query_matchers.rb

@@ -1,5 +1,35 @@
 require 'db_query_matchers/version'
 require 'db_query_matchers/make_database_queries'
 require 'db_query_matchers/query_counter'
+require 'db_query_matchers/configuration'
 require 'active_support'
 require 'active_record'
+
+# Main module that holds global configuration.
+module DBQueryMatchers
+  class << self
+    attr_writer :configuration
+  end
+
+  # Gets the current configuration
+  # @return [DBQueryMatchers::Configuration] the active configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Resets the current configuration.
+  # @return [DBQueryMatchers::Configuration] the active configuration
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+  # Updates the current configuration.
+  # @example
+  #   DBQueryMatchers.configure do |config|
+  #     config.ignores = [/SELECT.*FROM.*users/]
+  #   end
+  #
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/db_query_matchers/configuration.rb

@@ -0,0 +1,10 @@
+module DBQueryMatchers
+  # Configuration for the DBQueryMatcher module.
+  class Configuration
+    attr_accessor :ignores
+
+    def initialize
+      @ignores = []
+    end
+  end
+end

data/lib/db_query_matchers/make_database_queries.rb

@@ -8,7 +8,7 @@ require 'rspec'
 # @example
 #   expect { subject }.to make_database_queries(count: 1)
 #
-# @see QueryCounter
+# @see DBQueryMatchers::QueryCounter
 RSpec::Matchers.define :make_database_queries do |options = {}|
   supports_block_expectations
 
@@ -24,7 +24,7 @@ RSpec::Matchers.define :make_database_queries do |options = {}|
   end
 
   match do |block|
-    @counter = QueryCounter.new
+    @counter = DBQueryMatchers::QueryCounter.new
     ActiveSupport::Notifications.subscribed(@counter.to_proc,
                                             'sql.active_record',
                                             &block)

data/lib/db_query_matchers/query_counter.rb

@@ -1,43 +1,48 @@
-# 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
+module DBQueryMatchers
+  # 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 = DBQueryMatchers::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
+    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
+    # 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]
+    # 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)
+      return if DBQueryMatchers.configuration.ignores.any? do |pattern|
+        payload[:sql] =~ pattern
+      end
+      @count += 1
+      @log << payload[:sql]
+    end
   end
 end

data/lib/db_query_matchers/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Causes Engineering
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -79,6 +79,7 @@ extra_rdoc_files: []
 files:
 - lib/db-query-matchers.rb
 - lib/db_query_matchers.rb
+- lib/db_query_matchers/configuration.rb
 - lib/db_query_matchers/make_database_queries.rb
 - lib/db_query_matchers/query_counter.rb
 - lib/db_query_matchers/version.rb