rspec_nested_transactions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcdc9084dfae8ca0623c164885b9d695190c336b
+  data.tar.gz: 64e6b4c8002206b296f5ce9f9c027f7eeded3264
+SHA512:
+  metadata.gz: 16d9fc5ee5fa0a7efbd516ba729298a2f7b2236d66235329164c5fd850cf4ad325855c7cdf0c576a5bea14003bb47c272e900d5bfc58189e3c4bb98a5e4f144f
+  data.tar.gz: 67ba6f6788e5ec27c795363a43b2d28c2a970bc7e3d771a17a1e3db919f4a594e557bccbcc254d58cefcd6a632d3a9cd9a9c69e357c6a24c39331fb96605ebe8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_nested_transactions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rodrigo Rosenfeld Rosas
+
+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,107 @@
+# RSpec Nested Transactions [![Build Status](https://travis-ci.org/rosenfeld/rspec_nested_transactions.svg?branch=master)](https://travis-ci.org/rosenfeld/rspec_nested_transactions)
+
+Creating the same records in the database for every single test in a group can slow down your
+suite. This is a common approach when using factories rather than fixtures loaded in suite
+initialization. I much prefer factories over fixtures but for a long time I employ a technique
+that enable a test suite to perform as well as using fixtures (or better if you're running
+just a few tests from the suite) and read as good as you are used to when using factories.
+
+Some databases, like PostgreSQL, allow transaction savepoints. That means it's possible to
+run inner transactions inside an outer transaction to put in simple words.
+
+So, if you were able to create a set of records in a before(:all) context and rollback those
+changes once the context is finished, then there would no need to recreate those records for
+each example in the context. If you also run each example in an inner transaction, that
+means the examples will be still isolated from each other with regards to the database state.
+
+RSpec doesn't allow one to run an `around` hook that would include contexts besides examples.
+
+[Myron Marston wrote an article explaining how to use Ruby Fibers to implement around(:all)
+on RSpec](http://myronmars.to/n/dev-blog/2012/03/building-an-around-hook-using-fibers). It's
+an interesting idea and I used the concept to implement this feature.
+
+# Requirements
+
+The specs for this project will only run on Ruby 2.3 and above due to the `<<~` heredoc usage,
+but I suspect it works on any Ruby >= 2.0 (due to `prepend` usage).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_nested_transactions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_nested_transactions
+
+## Usage
+
+```ruby
+RSpec.configure do |c|
+  c.nested_transaction do |example_or_group, run|
+    (run[]; next) unless example_or_group.metadata[:db] # or delete this line if you don't care
+    # With Sequel and PostgreSQL:
+    DB.transaction(savepoint: true, rollback: :always, &run)
+
+    # Alternatively:
+    # conditionally issue a "BEGIN" or "SAVEPOINT #{dynamic_savepoint_name}"
+    # run[]
+    # conditionally issue a "ROLLBACK" or "ROLLBACK TO SAVEPOINT #{dynamic_savepoint_name}"
+  end
+end
+```
+
+After that every context and example will be enclosed in a (inner) transaction. No need for
+DatabaseCleaner (rolling back transactions are usually faster than truncate).
+
+`nested_transaction` can also be called from inside `describe`/`context` groups just like
+`around`:
+
+```ruby
+RSpec.describe "Some Feature" do
+  nested_transaction do |example_or_group, run|
+    # do something and call run[] ( or run.call/run.(), your call )
+  end
+end
+```
+
+## Is it "production" safe?
+
+Well, I've been using this technique since 2013 using [my fork of rspec_around_all](https://github.com/rosenfeld/rspec_around_all/tree/config_around).
+
+Actually I've been using it for much longer, but using some monkey patches around Sequel, before
+I read Myron's post. However, that code from 2013 is used to this date without changes so I
+consider it to be stable. That's why I decided to clean it up by removing the parts I didn't
+need, used a separate methods (instead of reusing `around`) and improved the specs to be clearer.
+As a result they now require Ruby 2.3 to run. Also, it now uses `prepend` rather than
+`Object.instance_method(:extend).bind(c).call`, which means it now requires Ruby >= 2.
+
+I never had problems with my test database becoming inconsistents during all those years.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to
+run the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub](https://github.com/rosenfeld/rspec_nested_transactions).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rspec_nested_transactions'
+
+# 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

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/rspec_nested_transactions.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'fiber'
+require 'rspec_nested_transactions/version'
+
+module RspecNestedTransactions
+  class FiberAwareGroup < SimpleDelegator
+    def run_examples
+      Fiber.yield
+    end
+
+    def to_proc
+      proc { run_examples }
+    end
+
+    def class
+      __getobj__.class
+    end
+  end
+
+  def nested_transaction(&block)
+    around &wrapped_block(&block)
+    nested_transaction_contexts(&block)
+  end
+
+  private
+
+  FIBERS_STACK = []
+
+  def wrapped_block
+    ->(c){ yield c, ->(*args){ c.respond_to?(:run) ? c.run : c.run_examples } }
+  end
+
+  def nested_transaction_contexts(&block)
+    (handle_config_around &block; return) if ::RSpec::Core::Configuration === self
+    around_all(false) do |group|
+      group.children.each {|c| c.send :nested_transaction_contexts, &block }
+      block[ group, ->(*args){ group.run_examples } ]
+    end
+  end
+
+  CONFIG_AROUND_ALL_NESTED_BLOCKS = []
+  CONFIG_AROUND_ALL_PROCESSED_BY_GROUP = {}
+  def handle_config_around(store = true, prepend = false, &block)
+    blocks = CONFIG_AROUND_ALL_NESTED_BLOCKS
+    blocks << block if store
+    around_all(prepend) do |group|
+      unless CONFIG_AROUND_ALL_PROCESSED_BY_GROUP[group.name]
+        CONFIG_AROUND_ALL_PROCESSED_BY_GROUP[group.name] = true
+        blocks.reverse_each do |b|
+          group.children.each{|c| c.send :handle_config_around, false, true, &b }
+        end
+      end
+      block[ group, ->(*args){group.run_examples } ]
+    end
+  end
+
+  def around_all(prepend, &block)
+    methods = {
+      before: method(prepend ? :prepend_before : :before),
+      after:  method(prepend ? :prepend_after  : :after),
+    }
+
+    methods[:before].call :all do |group|
+      fiber = Fiber.new(&block)
+      FIBERS_STACK << fiber
+      fiber.resume(FiberAwareGroup.new(group.class))
+    end
+
+    methods[:after].call :all do
+      fiber = FIBERS_STACK.pop
+      fiber.resume
+    end
+  end
+end
+
+RSpec.configure do |c|
+  # make it available to example groups:
+  # c.extend overrides the original Object#extend method.
+  # See discussion in https://github.com/rspec/rspec-core/issues/1031#issuecomment-22264638
+  c.extend RspecNestedTransactions
+
+  # Add config.nested_transaction{}
+  c.class.prepend RspecNestedTransactions
+  # or RSpec::Core::Configuration.prepend RspecNestedTransactions
+end
+

data/lib/rspec_nested_transactions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RspecNestedTransactions
+  VERSION = '0.1.0'
+end

data/rspec_nested_transactions.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_nested_transactions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_nested_transactions'
+  spec.version       = RspecNestedTransactions::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{Enable nested transactions for suites, contexts and examples. Useful to rollback DB changes in before(:all) blocks.}
+  spec.homepage      = 'https://github.com/rosenfeld/rspec_nested_transactions'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'rspec'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rspec_nested_transactions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: 
+email:
+- rr.rosas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_nested_transactions.rb
+- lib/rspec_nested_transactions/version.rb
+- rspec_nested_transactions.gemspec
+homepage: https://github.com/rosenfeld/rspec_nested_transactions
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Enable nested transactions for suites, contexts and examples. Useful to rollback
+  DB changes in before(:all) blocks.
+test_files: []