rspec-query-limit 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in query_limit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2014 Monterail.com LLC
+
+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,54 @@
+# Rspec custom matchers for Rails query counter
+
+## Features
+
+- Prevent N+1 problem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-query-limit'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+Add to your ```spec/spec_helper.rb```
+
+```ruby
+require 'rspec/query_limit'
+```
+
+And then you can use matchers
+```ruby
+describe UserEmails do
+  describe '#primary_emails' do
+    users = User.all
+    expect { UserEmails.primary_emails(users) }.to query_limit_eq(2)
+  end
+end
+```
+
+## List of query limit matchers
+Numbers of queries must be equal
+
+```
+query_limit_eq(number)
+```
+
+## Inspiration from
+[Stackoverflow](http://stackoverflow.com/questions/5490411/counting-the-number-of-queries-performed)
+
+## 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 a new Pull Request

data/Rakefile

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

data/lib/rspec-query-limit.rb

@@ -0,0 +1 @@
+require 'rspec/query_limit'

data/lib/rspec/query_limit.rb

@@ -0,0 +1,3 @@
+require 'rspec/query_limit/version'
+require 'rspec/query_limit/query_counter'
+require 'rspec/query_limit/matchers'

data/lib/rspec/query_limit/matchers.rb

@@ -0,0 +1,29 @@
+module Rspec
+  module QueryLimit
+    RSpec::Matchers.define :query_limit_eq do |expected|
+
+      match do |block|
+        query_count(&block) == expected
+      end
+
+      failure_message_for_should do |actual|
+        "Expected to run exactly #{expected} queries, got #{@counter.query_count}"
+      end
+
+      failure_message_for_should_not do |actual|
+        "Expected to run other than #{expected} queries, got #{@counter.query_count}"
+      end
+
+      def query_count(&block)
+        @counter = ActiveRecord::QueryCounter.new
+        ActiveSupport::Notifications.subscribed(@counter.to_proc, 'sql.active_record', &block)
+        @counter.query_count
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+    end
+  end
+end

data/lib/rspec/query_limit/query_counter.rb

@@ -0,0 +1,23 @@
+module Rspec
+  module QueryLimit
+    module ActiveRecord
+      class QueryCounter
+
+        attr_reader :query_count
+
+        def initialize
+          @query_count = 0
+        end
+
+        def to_proc
+          lambda(&method(:callback))
+        end
+
+        def callback(name, start, finish, message_id, values)
+          @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name])
+        end
+
+      end
+    end
+  end
+end

data/lib/rspec/query_limit/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module QueryLimit
+    VERSION = "0.1.0"
+  end
+end

data/rspec-query-limit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/query_limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-query-limit"
+  spec.version       = Rspec::QueryLimit::VERSION
+  spec.authors       = ["Jakub Cieslar"]
+  spec.email         = ["cieslar.jakub@gmail.com"]
+  spec.summary       = %q{Rspec custom matchers for Rails query counter}
+  spec.description   = %q{Rspec custom matchers for Rails query counter}
+  spec.homepage      = "https://github.com/monterail/rspec-query-limit"
+  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_dependency 'rspec-rails'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rspec-query-limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jakub Cieslar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rspec custom matchers for Rails query counter
+email:
+- cieslar.jakub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-query-limit.rb
+- lib/rspec/query_limit.rb
+- lib/rspec/query_limit/matchers.rb
+- lib/rspec/query_limit/query_counter.rb
+- lib/rspec/query_limit/version.rb
+- rspec-query-limit.gemspec
+homepage: https://github.com/monterail/rspec-query-limit
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Rspec custom matchers for Rails query counter
+test_files: []