Skip to content
Let's you know when your code touches your database
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gitignore
Gemfile
README.md
Rakefile
nogo.gemspec

README.md

NoGo is a library to find the places in your code which touch your database

NoGo's main objective is to help find and prevent code which accesses the database during testing. Disconnecting the database completely while running your test suite may be impractical, so NoGo take a different approach by proxying an estabished database connection. It is possible to enable and disable NoGo as well as change between :raise, :warn and :pass_through strategies on the fly.

Installation

Add nogo to your Gemfile

gem 'nogo'

Or install from the command line

gem install nogo

Usage

NoGo can be used as a standalone library, but it does integrate with the RSpec 2 test framework.

RSpec

Wrap any spec examples that should not use the database adapter inside a "nogo do" block.

# In your specs
require 'nogo/rspec' # Automatically connects, so this should be included after the environment is loaded.

describe Klass do
  it 'works without error' do
    Klass.create
  end

  nogo do # Any access to the database inside this block will raise an exception
    it 'raises error' do
      expect{ Klass.create }.to raise_error
    end
  end

  it 'works without error' do
    Klass.create
  end
end

Globally enabling NoGo

By default NoGo will not check requests to the database, even after being connected. Here is an example of enabling NoGo.

require 'nogo'

# Database adapter should already be connected
NoGo::Connection.connect!

ModelKlass.create                   # Works as expected

NoGo::Connection.enabled = true
ModelKlass.create                   # Raises exception

NoGo::Connection.enabled = false
ModelKlass.create                   # Works as expected

Platforms

Tested with:

RSpec 2.7.0, 2.8.0 ActiveRecord 3.1.3, 3.2.1.

LICENSE

(The MIT License)

Copyright © 2012 Andy Ogzewalla

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.

Something went wrong with that request. Please try again.