noncommittal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '029ebe87976f291a4998cefd198ee1003f0fcca977072621851247164496d25b'
+  data.tar.gz: 17cf95e7f5e844d8fe226154092575cc8ec85089c1fac25e2dd2531ceb99b496
+SHA512:
+  metadata.gz: 183e8f4fcddcdf2673c72707df77d961b42a62002961d06dd2e8d6510e9cb7c27b47b30332bc0e5d23d33397f0e0b9cd7f87b44338e41e3649beb70c4fe95056
+  data.tar.gz: 27343c72bb0e819f7f6801866347dacdeeafce9d61c0844158bafe2e1f34dc0360c618f86605974e0abe960356f92862500916af5f55a703015e3bbb10ba7bee

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in noncommittal.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    noncommittal (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rubocop (1.4.2)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.10.1)
+    standard (0.10.2)
+      rubocop (= 1.4.2)
+      rubocop-performance (= 1.9.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  noncommittal!
+  rake (~> 12.0)
+  standard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Justin Searls
+
+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,95 @@
+# Noncommittal
+
+This gem helps you avoid test pollution in your Rails test suite by preventing
+tests from committing records to your Postgres database.
+
+## How to avoid commitment
+
+Add this to your Gemfile, probably grouped with other test gems:
+
+``` ruby
+group :test do
+  gem "noncommittal"
+end
+```
+
+Then, in your `test_helper.rb` (or similar), after you require your Rails
+environment, just drop this in:
+
+```ruby
+Noncommittal.start!(tables: [:users, :posts])
+```
+
+This will create an empty table called `noncommittal_no_rows_allowed` and, for
+each of your models, a deferred foreign key constraint that will effectively
+prevent any records from being committed outside the test transaction.
+
+## Do you have commitment issues?
+
+By default, Ruby on Rails tests run each test [in a
+transaction](https://guides.rubyonrails.org/testing.html#testing-parallel-transactions)
+that is rolled back at the end of each test. This is a performant way to create
+proper isolation, preventing tests that save records to the database from
+affecting the environment of your other tests.
+
+However, Rails can only enforce this constraint when the test-scoped code
+connects to the database via the framework and within that transaction. If a
+test were to extend `Minitest::Test` instead of `ActiveSupport::TestCase`, that
+test would not benefit from this rollback-only transaction protection. And if
+the [subject under
+test](https://github.com/testdouble/contributing-tests/wiki/Subject) contains
+transaction logic itself, or creates its own database connections, or spawns
+child processes, then it's entirely possible that some of your tests will
+erroneously commit records to the database, potentially causing [test
+pollution](https://github.com/testdouble/test-smells/tree/master/smells/unreliable/litter-bugs).
+
+Over the years, Rubyists have taken several approaches to mitigate this risk,
+but most popular solutions have drawbacks:
+
+* Gems like
+  [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner) that
+  purge your database between tests introduce a per-test runtime cost that is
+  much higher than relying on transaction rollbacks
+* Bisecting your test suite to identify which test that violates transaction
+  safety catches test pollution only after it causes a problem and is separately
+  time-consuming
+* Adding a before-hook that runs before each test to ensure tables are empty
+  won't give you a stack trace to the test that managed to commit inserted
+  records
+
+So that's why the noncommittal gem exists! It's fast, will catch this problem as
+soon as it's introduced, and will give you an accurate stack trace to the
+offending test.
+
+## What if I want to commit to certain tables?
+
+By default, noncommittal will gather the table names of all your models that
+descend from `ActiveRecord::Base`, but this may not be what you want (you might
+want to exclude certain models or include additional tables). To override this
+behavior, you can pass an array of table names to a `tables` keyword argument,
+like so:
+
+```ruby
+Noncommittal.start!(tables: [:users, :posts])
+```
+
+## Limitations
+
+This only works with Postgres currently. PRs welcome if you can accomplish the
+same behavior with other database adapters!
+
+## Acknowledgements
+
+This gem is a codification of [this
+tweet](https://twitter.com/searls/status/1336729988498862085?s=20), which itself
+was the brainchild of [Matthew Draper](https://github.com/matthewd).
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "noncommittal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/noncommittal.rb

@@ -0,0 +1,18 @@
+require "noncommittal/version"
+
+module Noncommittal
+  def self.start!(tables: nil)
+    tables ||= ActiveRecord::Base.descendants.map(&:table_name).compact.uniq - ["ar_internal_metadata", "schema_migrations"]
+
+    ActiveRecord::Base.connection.execute <<~SQL
+      create table if not exists noncommittal_no_rows_allowed (id bigint unique);
+      #{tables.map { |table_name|
+        constraint_name = "noncommittal_#{table_name}"
+        <<~SQL
+          alter table #{table_name} drop constraint if exists #{constraint_name};
+          alter table #{table_name} add constraint #{constraint_name} foreign key (id) references noncommittal_no_rows_allowed (id) deferrable initially deferred;
+        SQL
+      }.join("\n")}
+    SQL
+  end
+end

data/lib/noncommittal/version.rb

@@ -0,0 +1,3 @@
+module Noncommittal
+  VERSION = "0.1.0"
+end

data/noncommittal.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/noncommittal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "noncommittal"
+  spec.version = Noncommittal::VERSION
+  spec.authors = ["Justin Searls"]
+  spec.email = ["searls@gmail.com"]
+
+  spec.summary = "Ensures test isolation by preventing your Rails tests from committing to the database"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = "https://github.com/testdouble/noncommittal"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: noncommittal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Searls
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-10 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/noncommittal.rb
+- lib/noncommittal/version.rb
+- noncommittal.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testdouble/noncommittal
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Ensures test isolation by preventing your Rails tests from committing to
+  the database
+test_files: []