query_matchers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35b67c78575fc9084086e8370d01dd4260a222f1
+  data.tar.gz: 021976b186936028ddb85da274c7d18796b36fb2
+SHA512:
+  metadata.gz: 870b37b067ab66a308f4b3be5e7b5b8f3c974e10125e5662a6a7fe3028ceda654bb7702d9680d8f71f511734cefa3b1b4010a686d12ad63890a21d4f2f3220f4
+  data.tar.gz: 498c380b1fbb2e19b27687f668b9216cd584a61d8f21d3adaf883e8e4cacdb27f6e05e5781df409bed789f2d5d9aea91fb408fadcc2c0ac34cea538926986ab7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Schierbeck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# QueryMatchers
+
+Match the number of queries performed in any block of code. Allows setting in place regression tests for database performance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'query_matchers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_matchers
+
+## Usage
+
+```ruby
+expect { magician.magic! }.to execute_queries(43)
+expect { does_not_hit_the_database }.to execute_no_queries
+expect { hits_the_database_once }.to execute_one_query
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/query_matchers.rb

@@ -0,0 +1,16 @@
+require 'query_matchers/version'
+require 'query_matchers/query_execution_matcher'
+
+module QueryMatchers
+  def execute_queries(n)
+    QueryExecutionMatcher.new(n)
+  end
+
+  def execute_one_query
+    QueryExecutionMatcher.new(1)
+  end
+
+  def execute_no_queries
+    QueryExecutionMatcher.new(0)
+  end
+end

data/lib/query_matchers/query_counter.rb

@@ -0,0 +1,34 @@
+module QueryMatchers
+  class QueryCounter
+    OPERATIONS = %w(SELECT INSERT UPDATE DELETE)
+
+    def initialize
+      @events = []
+    end
+
+    def execute!(target)
+      ActiveSupport::Notifications.subscribed(subscriber, 'sql.active_record', &target)
+    end
+
+    def query_count
+      @events.size
+    end
+
+    def queries
+      @events.map {|event| event.payload[:sql] }
+    end
+
+    private
+
+    def subscriber
+      lambda do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        @events << event if count_query?(event.payload[:sql])
+      end
+    end
+
+    def count_query?(sql)
+      OPERATIONS.any? {|op| sql.start_with?(op) }
+    end
+  end
+end

data/lib/query_matchers/query_execution_matcher.rb

@@ -0,0 +1,27 @@
+require 'active_support/notifications'
+require 'query_matchers/query_counter'
+
+module QueryMatchers
+  class QueryExecutionMatcher
+    def initialize(expected, counter = QueryCounter.new)
+      @expected = expected
+      @counter = counter
+    end
+
+    def matches?(target)
+      @counter.execute!(target)
+
+      @counter.query_count == @expected
+    end
+
+    def failure_message
+      "expected block to execute #{@expected} SQL queries, " <<
+        "but executed #{@counter.query_count}: \n\n" <<
+        @counter.queries.map {|q| " - #{q}" }.join("\n")
+    end
+
+    def negative_failure_message
+      "expected block not to execute #{@expected} SQL queries, but did"
+    end
+  end
+end

data/lib/query_matchers/version.rb

@@ -0,0 +1,3 @@
+module QueryMatchers
+  VERSION = "0.0.1"
+end

data/query_matchers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_matchers"
+  spec.version       = QueryMatchers::VERSION
+  spec.authors       = ["Daniel Schierbeck"]
+  spec.email         = ["dasch@zendesk.com"]
+  spec.summary       = %q{Match the number of queries performed in any block of code}
+  spec.homepage      = "https://github.com/dasch/query_matchers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ["> 3.0", "<= 4.1"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.0"
+end

data/spec/query_counter_spec.rb

@@ -0,0 +1,58 @@
+require 'active_support/notifications'
+require 'query_matchers/query_counter'
+
+describe QueryMatchers::QueryCounter do
+  let(:counter) { described_class.new }
+
+  it "records all relevant SQL operations performed in the target block" do
+    query = "SELECT * FROM somewhere"
+    counter.execute!(sql_target(query))
+
+    counter.queries.should == [query]
+  end
+
+  it "counts the number of queries performed in the target block" do
+    target = proc { 3.times { perform_sql("INSERT INTO jokes") } }
+    counter.execute!(target)
+
+    counter.query_count.should == 3
+  end
+
+  it "counts INSERT queries" do
+    counter.execute!(sql_target("INSERT INTO jokes"))
+
+    counter.query_count.should == 1
+  end
+
+  it "counts UPDATE queries" do
+    counter.execute!(sql_target("UPDATE mood SET laughing = 0"))
+
+    counter.query_count.should == 1
+  end
+
+  it "counts DELETE queries" do
+    counter.execute!(sql_target("DELETE FROM goodwill"))
+
+    counter.query_count.should == 1
+  end
+
+  it "counts SELECT queries" do
+    counter.execute!(sql_target("SELECT FROM inventory"))
+
+    counter.query_count.should == 1
+  end
+
+  it "doesn't count any other type of query" do
+    counter.execute!(sql_target("BREAKDANCE"))
+
+    counter.query_count.should == 0
+  end
+
+  def sql_target(sql)
+    proc { perform_sql(sql) }
+  end
+
+  def perform_sql(sql)
+    ActiveSupport::Notifications.instrument('sql.active_record', sql: sql)
+  end
+end

data/spec/query_execution_matcher_spec.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/string/strip'
+require 'query_matchers/query_execution_matcher'
+
+describe QueryMatchers::QueryExecutionMatcher do
+  let(:counter) { double("counter", query_count: 0) }
+  let(:matcher) { described_class.new(4, counter) }
+
+  describe "#matches?" do
+    before do
+      counter.stub(:execute!)
+    end
+
+    it "executes the target" do
+      matcher.matches?(:whatever)
+      counter.should have_received(:execute!).with(:whatever)
+    end
+
+    it "returns true if the number of queries performed matched the expectation" do
+      counter.stub(:query_count) { 4 }
+      matcher.matches?(:whatever).should == true
+    end
+
+    it "returns false if the number of queries performed doesn't match the expectation" do
+      counter.stub(:query_count) { 3 }
+      matcher.matches?(:whatever).should == false
+    end
+  end
+
+  describe "#failure_message" do
+    it "lists the queries performed in the target" do
+      query1 = "SELECT FROM jokes WHERE puns > 3"
+      query2 = "DELETE FROM jokes WHERE inappropriate = 1"
+
+      counter.stub(:query_count) { 99 }
+      counter.stub(:queries) { [query1, query2] }
+
+      matcher.failure_message.should == <<-MESSAGE.strip_heredoc.chomp
+        expected block to execute 4 SQL queries, but executed 99: 
+
+         - SELECT FROM jokes WHERE puns > 3
+         - DELETE FROM jokes WHERE inappropriate = 1
+       MESSAGE
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: query_matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: 
+email:
+- dasch@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/query_matchers.rb
+- lib/query_matchers/query_counter.rb
+- lib/query_matchers/query_execution_matcher.rb
+- lib/query_matchers/version.rb
+- query_matchers.gemspec
+- spec/query_counter_spec.rb
+- spec/query_execution_matcher_spec.rb
+homepage: https://github.com/dasch/query_matchers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Match the number of queries performed in any block of code
+test_files:
+- spec/query_counter_spec.rb
+- spec/query_execution_matcher_spec.rb
+has_rdoc: