database_plumber 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56ed59f538667d495b0d65ff3f41123960c24ad3
+  data.tar.gz: 176d79d1c384c06e07c1545e80c2d48c328fb55a
+SHA512:
+  metadata.gz: ccdc5f2947c9ae74775e53f096d8c1576331101e54e5f62dfd90f2b4e7798b9a1374ac585da556dac6eb5f0764af911ad6deffe9bb196cce44b55e0e718123d9
+  data.tar.gz: fb8dab7896d3c5da4fc595fdc6d0736cba4f48e871b82f6c0eeb488f0a078803b7bf94bd519608da69c90acf1a34b7690a3097cf4854104cd7795ac711472a34

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+database_plumber

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.3
+
+script:
+  - bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Barry Gordon
+
+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,151 @@
+# DatabasePlumber [![Build Status](https://travis-ci.org/brrygrdn/database_plumber.svg?branch=v0.0.1)](https://travis-ci.org/brrygrdn/database_plumber)
+
+A common problem in test suites for large [Rails][rails] applications is that,
+as they mature, balancing test speed and complexity often results in heavy use
+of tools like [FactoryGirl][factorygirl] and [DatabaseCleaner][databasecleaner].
+
+These are powerful and useful tools, but over time it often becomes evident that
+large factories can create and orphan many rows in the database; combine with the
+need for non-transactional database maintenance during [Capybara][capybara] tests
+and its very easy to be plagued by mystery guests.
+
+DatabasePlumber is a quick utility that checks for rows left after an example
+group has been executed, publishes a report and cleans up.
+
+## Why use this?
+
+Well, for starters, it acts as a quick sticking plaster on the problem of mystery
+guests, giving you back confidence in your CI runs in the short term.
+
+Long-term, it removes the fear from optimizing the persistence of objects using
+[RSpec][rspec] `before(:all)` blocks by making it clear when you, or your factories
+have not cleaned up properly after.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'database_plumber', github: 'brrygrdn/database_plumber'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+To get started, add the following lines to your `spec_helper.rb`
+
+```ruby
+RSpec.configure do |config|
+
+  ...
+
+  config.after(:each) do |example|
+    DatabaseCleaner.clean
+    # Notify DatabasePlumber of each example after it has been executed
+    DatabasePlumber.log example
+  end
+
+  config.after(:all) do
+    # Perform the report after each example group
+    DatabasePlumber.inspect
+  end
+
+  ...
+
+end
+```
+
+Run your tests as normal, and you'll see a report after any examples:
+
+```
+> bundle exec rspec spec/models/
+.....
+#### Leaking Test
+
+  The spec './spec/models/foo_spec.rb' leaves
+  the following rows in the database:
+
+     - 1 row(s) for the Foo model
+     - 5 row(s) for the Bar model
+
+#### What now?
+
+  If you are using let! or before(:all) please ensure that you use a
+  corresponding after(:all) block to clean up these rows.
+
+..........
+
+Finished in 3.14159 seconds
+15 examples, 0 failures
+
+Randomized with seed 17015
+```
+
+### Ignoring Models
+
+You may have some models that you don't want to report on, for example a configuration
+table that is seeded or loaded with fixtures as part of test suite setup.
+
+```ruby
+config.after(:all) do
+  # Perform the report after each example group
+  DatabasePlumber.inspect ignored_models: [Bar, Baz]
+end
+```
+
+### Ignoring Databases
+
+You may have models in your application backed by multiple adapters, some of which
+may be throw-away after each example group e.g. using SQLite for anonymous models
+
+To exclude all models from a given adapter, you can add the following:
+
+```ruby
+config.after(:all) do
+  # Perform the report after each example group
+  DatabasePlumber.inspect ignored_adapters: [:sqlite]
+end
+```
+
+If you are unsure of which adapter to ignore, you can check via the Rails console:
+
+```ruby
+  > Foo.connection.adapter_name
+  'PostgreSQL'
+  # The corresponding symbol to use is :postgresql
+```
+
+### Halting Tests on a Leak
+
+When debugging a suite with several mystery guests, you can halt immediately
+after each leak.
+
+```ruby
+config.after(:all) do
+  # Perform the report after each example group
+  DatabasePlumber.inspect ignored_models: [Bar, Baz],
+                          ignored_adapters: [:sqlite],
+                          brutal: true
+end
+```
+
+This is also useful if your test suite is problem-free and you would like ensure it
+stays that way.
+
+## Contributing
+
+1. Fork it ( https://github.com/brrygrdn/database_plumber/fork )
+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
+
+[rails]: https://github.com/rails/rails
+[factorygirl]: https://github.com/thoughtbot/factory_girl
+[databasecleaner]: https://github.com/DatabaseCleaner/database_cleaner
+[capybara]: https://github.com/jnicklas/capybara
+[rspec]: https://github.com/rspec/rspec

data/Rakefile

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

data/database_plumber.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'database_plumber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_plumber"
+  spec.version       = DatabasePlumber::VERSION
+  spec.authors       = ["Barry Gordon", "David Kennedy"]
+  spec.email         = ["hello@barrygordon.co.uk", "dave@dkennedy.org"]
+  spec.summary       = %q{Finds leaky ActiveRecord models in your specs.}
+  spec.homepage      = "https://github.com/brrygrdn/database_plumber"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "rspec"
+  spec.add_runtime_dependency "highline"
+end

data/lib/database_plumber/leak_finder.rb

@@ -0,0 +1,57 @@
+module DatabasePlumber
+  class LeakFinder
+    class InvalidModelError < StandardError ; end
+
+    IGNORED_AR_INTERNALS = [ActiveRecord::SchemaMigration]
+    private_constant :IGNORED_AR_INTERNALS
+
+    def self.inspect(options = {})
+      new(options).inspect
+    end
+
+    def initialize(options)
+      @ignored_models = (options[:ignored_models] || []) + IGNORED_AR_INTERNALS
+      @ignored_adapters = options[:ignored_adapters] || []
+    end
+
+    def inspect
+      filtered_models.each_with_object({}) do |model, results|
+        records = count_for(model)
+        if records > 0
+          results[model.to_s] = records
+          mop_up(model)
+        end
+        results
+      end
+    end
+
+    private
+
+    def count_for(model)
+      return 0 if no_table?(model)
+      model.count
+    rescue ActiveRecord::StatementInvalid
+      raise InvalidModelError, "#{model} does not have a valid table definition"
+    end
+
+    def mop_up(model)
+      model.destroy_all
+    end
+
+    def no_table?(model)
+      model.abstract_class? || @ignored_adapters.include?(model.connection.adapter_name.downcase.to_sym)
+    end
+
+    def filtered_models
+      model_space.reject(&method(:excluded_model?))
+    end
+
+    def excluded_model?(model)
+      @ignored_models.include?(model) || model.name =~ /^HABTM_/
+    end
+
+    def model_space
+      ActiveRecord::Base.descendants
+    end
+  end
+end

data/lib/database_plumber/report.rb

@@ -0,0 +1,35 @@
+require 'highline'
+
+module DatabasePlumber
+  class Report
+    def self.on(example, leaks)
+      puts <<-REPORT.strip_heredoc
+
+        #{HighLine.color('#### Leaking Test', :red)}
+
+          The spec '#{HighLine.color(spec_path_for(example), :red, :underline)}' leaves
+          the following rows in the database:
+
+      REPORT
+
+      leaks.each(&method(:print_leak))
+
+      puts <<-REPORT.strip_heredoc
+
+      #{HighLine.color('#### What now?', :yellow)}
+
+        If you are using #{HighLine.color('let!', :yellow)} or #{HighLine.color('before(:all)', :yellow)} please ensure that you use a
+        corresponding #{HighLine.color('after(:all)', :yellow)} block to clean up these rows.
+
+      REPORT
+    end
+
+    private_class_method def self.print_leak(model, count)
+      puts "     - #{HighLine.color(count.to_s, :blue)} row(s) for the #{model} model \n"
+    end
+
+    private_class_method def self.spec_path_for(example)
+      example.metadata[:example_group][:file_path]
+    end
+  end
+end

data/lib/database_plumber/version.rb

@@ -0,0 +1,3 @@
+module DatabasePlumber
+  VERSION = '1.0.0'
+end

data/lib/database_plumber.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+require 'database_plumber/leak_finder'
+require 'database_plumber/report'
+require 'database_plumber/version'
+
+module DatabasePlumber
+  def self.log(example)
+    @example = example
+  end
+
+  def self.inspect(options = {})
+    leaks = LeakFinder.inspect(options)
+    unless leaks.empty?
+      Report.on @example, leaks
+      exit! if options[:brutal]
+    end
+  end
+end

data/spec/lib/database_plumber/leak_finder_spec.rb

@@ -0,0 +1,129 @@
+RSpec.describe DatabasePlumber::LeakFinder do
+  let(:normal_connection)   { double(:connection, adapter_name: 'NotSQLite') }
+  let(:ignored_connection)  { double(:connection, adapter_name: 'SQLite') }
+
+  let(:happy_model)           { double(:happy,    name: 'Happy',        abstract_class?: nil,  connection: normal_connection,  count: 0) }
+  let(:leaky_model)           { double(:leaky,    name: 'Leaky',        abstract_class?: nil,  connection: normal_connection,  count: 1) }
+  let(:abstract_model)        { double(:abstract, name: 'Abstract',     abstract_class?: true, connection: normal_connection,  count: 2) }
+  let(:ignored_model)         { double(:ignored,  name: 'Ignored',      abstract_class?: nil,  connection: normal_connection,  count: 3) }
+  let(:ignored_adapter_model) { double(:anon,     name: 'Anon',         abstract_class?: nil,  connection: ignored_connection, count: 4) }
+  let(:join_model_stub)       { double(:habtm,    name: 'HABTM_Things', abstract_class?: nil,  connection: normal_connection,  count: 5) }
+
+  let(:globally_ignored_models) { [ActiveRecord::SchemaMigration] }
+
+  let(:model_space)     { [happy_model, leaky_model, ignored_model, abstract_model, ignored_adapter_model, join_model_stub] | globally_ignored_models }
+
+  before(:each) do
+    model_space.each do |model|
+      allow(model).to receive(:destroy_all)
+    end
+    allow(ActiveRecord::Base).to receive(:descendants) { model_space }
+  end
+
+  describe '.inspect' do
+    context 'with no params' do
+      let(:expected_leaks) do
+        {
+          leaky_model.to_s => 1,
+          ignored_model.to_s => 3,
+          ignored_adapter_model.to_s => 4
+        }
+      end
+
+      before(:each) { @leaks = described_class.inspect }
+
+      it { expect(@leaks).to eql(expected_leaks) }
+
+      it { expect(ActiveRecord::SchemaMigration).not_to have_received(:destroy_all) }
+
+      it { expect(happy_model).not_to have_received(:destroy_all) }
+      it { expect(leaky_model).to have_received(:destroy_all) }
+
+      it { expect(ignored_model).to have_received(:destroy_all) }
+      it { expect(ignored_adapter_model).to have_received(:destroy_all) }
+
+      it { expect(join_model_stub).not_to have_received(:destroy_all) }
+    end
+
+    context 'with an ignored model' do
+      let(:options_params) do
+        {
+          ignored_models: [ignored_model]
+        }
+      end
+
+      let(:expected_leaks) do
+        {
+          leaky_model.to_s => 1,
+          ignored_adapter_model.to_s => 4
+        }
+      end
+
+      before(:each) { @leaks = described_class.inspect(options_params) }
+
+      it { expect(@leaks).to eql(expected_leaks) }
+
+      it { expect(ActiveRecord::SchemaMigration).not_to have_received(:destroy_all) }
+
+      it { expect(happy_model).not_to have_received(:destroy_all) }
+      it { expect(leaky_model).to have_received(:destroy_all) }
+
+      it { expect(ignored_model).not_to have_received(:destroy_all) }
+      it { expect(ignored_adapter_model).to have_received(:destroy_all) }
+
+      it { expect(join_model_stub).not_to have_received(:destroy_all) }
+    end
+
+    context 'with an ignored adapter' do
+      let(:options_params) do
+        {
+          ignored_adapters: [:sqlite]
+        }
+      end
+
+      let(:expected_leaks) do
+        {
+          leaky_model.to_s => 1,
+          ignored_model.to_s => 3
+        }
+      end
+
+      before(:each) { @leaks = described_class.inspect(options_params) }
+
+      it { expect(@leaks).to eql(expected_leaks) }
+
+      it { expect(ActiveRecord::SchemaMigration).not_to have_received(:destroy_all) }
+
+      it { expect(happy_model).not_to have_received(:destroy_all) }
+      it { expect(leaky_model).to have_received(:destroy_all) }
+
+      it { expect(ignored_model).to have_received(:destroy_all) }
+      it { expect(ignored_adapter_model).not_to have_received(:destroy_all) }
+
+      it { expect(join_model_stub).not_to have_received(:destroy_all) }
+    end
+
+    context 'with no leaking models in scope' do
+      let(:options_params) do
+        {
+          ignored_models: [ignored_model, leaky_model],
+          ignored_adapters: [:sqlite]
+        }
+      end
+
+      before(:each) { @leaks = described_class.inspect(options_params) }
+
+      it { expect(@leaks).to be_empty }
+
+      it { expect(ActiveRecord::SchemaMigration).not_to have_received(:destroy_all) }
+
+      it { expect(happy_model).not_to have_received(:destroy_all) }
+      it { expect(leaky_model).not_to have_received(:destroy_all) }
+
+      it { expect(ignored_model).not_to have_received(:destroy_all) }
+      it { expect(ignored_adapter_model).not_to have_received(:destroy_all) }
+
+      it { expect(join_model_stub).not_to have_received(:destroy_all) }
+    end
+  end
+end

data/spec/lib/database_plumber_spec.rb

@@ -0,0 +1,31 @@
+RSpec.describe DatabasePlumber do
+  let(:report_class) { DatabasePlumber::Report }
+
+  let(:current_example) { self }
+
+  before(:each) do
+    allow(report_class).to receive(:on)
+    described_class.log current_example
+  end
+
+  context 'with no leaks' do
+    before(:each) do
+      described_class.inspect
+    end
+
+    it { expect(report_class).not_to have_received(:on) }
+  end
+
+  context 'with leaks' do
+    let(:leaks) do
+      { 'Foo' => 5 }
+    end
+
+    before(:each) do
+      allow(DatabasePlumber::LeakFinder).to receive(:inspect) { leaks }
+      described_class.inspect
+    end
+
+    it { expect(report_class).to have_received(:on).with(current_example, leaks) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'pry'
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'database_plumber'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: database_plumber
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Barry Gordon
+- David Kennedy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hello@barrygordon.co.uk
+- dave@dkennedy.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- database_plumber.gemspec
+- lib/database_plumber.rb
+- lib/database_plumber/leak_finder.rb
+- lib/database_plumber/report.rb
+- lib/database_plumber/version.rb
+- spec/lib/database_plumber/leak_finder_spec.rb
+- spec/lib/database_plumber_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brrygrdn/database_plumber
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Finds leaky ActiveRecord models in your specs.
+test_files:
+- spec/lib/database_plumber/leak_finder_spec.rb
+- spec/lib/database_plumber_spec.rb
+- spec/spec_helper.rb