minitest-hooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a0a8293b0c8dbbad1e27c3d3e6cb9bf92fc59a3
+  data.tar.gz: 56adcfa31aaaea60a526c44f092216d315ffa082
+SHA512:
+  metadata.gz: ade327c7055a6f152143ad1f8f6d20d7142c43cfc54f76f2a281c99cd00df52751f81abf301b74c5ce14c7382d13afa7a9d7038d5d7669bc200f68ebfe23ba64
+  data.tar.gz: b4020676c1ce37af3cd6f2903c1455c44cef0229365a08f83caa93832134a3b29aa21724ddfa682bf38bd09642f80495127a135e17601ad08b4eb76b7726035b

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2015-04-26)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2015 Jeremy Evans
+
+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 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.rdoc

@@ -0,0 +1,95 @@
+= minitest-hooks
+
+minitest-hooks adds around and before_all/after_all/around_all hooks for Minitest.
+This allows you do things like run each suite of specs inside a database transaction,
+running each spec inside its own savepoint inside that transaction, which can
+significantly speed up testing for specs that share expensive database setup code.
+
+= Installation
+
+  gem install enum_csv
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/minitest-hooks
+
+= Usage
+
+== Using the library
+
+=== For all specs
+
+  require 'minitest/hooks/default'
+
+=== For some specs
+
+First, you need to require the library.
+
+  require 'minitest/hooks'
+
+Or you can set the default for some specs to be <tt>Minitest::HooksSpec</tt>:
+
+  MiniTest::Spec.register_spec_type(/something/, Minitest::HooksSpec)
+
+Alternatively, you can include <tt>Minitest::Hooks</tt> in a specific spec class:
+
+  describe 'something' do
+    include Minitest::Hooks
+  end
+
+But if you do this, you need to make sure that any +around+ and +around_all+
+methods defined in the class itself call +yield+ instead of +super+.
+
+== before_all Hooks
+
+To run code before any specs in the suite are executed, pass +:all+ to +before+:
+
+  describe 'something' do
+    before(:all) do
+      DB[:table].insert(:column=>1)
+    end
+  end
+
+== after_all Hooks
+
+To run code after all specs in the suite are executed, pass +:all+ to +after+:
+
+  describe 'something' do
+    after(:all) do
+      DB[:table].delete
+    end
+  end
+
+== around Hooks
+
+To run code around each spec in a suite, define the +around+ method and have it
+call +super+:
+
+  describe 'something' do
+    def around
+      DB.transaction(:rollback=>:always, :savepoint=>true, :auto_savepoint=>true) do
+        super
+      end
+    end
+  end
+
+== around_all Hooks
+
+To run code around all specs in a suite, define the +around_all+ method and have
+it call +super+:
+
+  describe 'something' do
+    def around_all
+      DB.transaction(:rollback=>:always) do
+        super
+      end
+    end
+  end
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,46 @@
+require "rake"
+require "rake/clean"
+require 'rake/testtask'
+
+CLEAN.include ["enum_csv-*.gem", "rdoc", "coverage"]
+
+desc "Build minitest-hooks gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build minitest-hooks.gemspec}
+end
+
+### Specs
+
+desc "Run specs"
+task :spec do
+  sh %{#{FileUtils::RUBY} -I lib spec/minitest_hooks_spec.rb}
+end
+
+task :default=>:spec
+
+### RDoc
+
+RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'minitest-hooks: around and before_all/after_all/around_all hooks for Minitest']
+
+begin
+  gem 'hanna-nouveau'
+  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+rdoc_task_class = begin
+  require "rdoc/task"
+  RDoc::Task
+rescue LoadError
+  require "rake/rdoctask"
+  Rake::RDocTask
+end
+
+RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
+
+rdoc_task_class.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end
+

data/lib/minitest/hooks.rb

@@ -0,0 +1,107 @@
+require 'minitest/spec'
+
+# Add support for around and before_all/after_all/around_all hooks to
+# minitest spec classes.
+module Minitest::Hooks
+  # Add the class methods to the class. Also, include an additional
+  # module in the class that before(:all) and after(:all) methods
+  # work on a class that directly includes this module.
+  def self.included(mod)
+    super
+    mod.instance_exec do
+      include(@hooks_module ||= Module.new)
+      extend(Minitest::Hooks::ClassMethods)
+    end
+  end
+
+  # Empty method, necessary so that super calls in spec subclasses work.
+  def before_all
+  end
+
+  # Empty method, necessary so that super calls in spec subclasses work.
+  def after_all
+  end
+
+  # Method that just yields, so that super calls in spec subclasses work.
+  def around_all
+    yield
+  end
+
+  # Method that just yields, so that super calls in spec subclasses work.
+  def around
+    yield
+  end
+
+  # Run around hook inside, since time_it is run around every spec.
+  def time_it
+    super do
+      around do
+        yield
+      end
+    end
+  end
+end
+
+module Minitest::Hooks::ClassMethods
+  # Object used to get an empty new instance, as new by default will return
+  # a dup of the singleton instance.
+  NEW = Object.new.freeze
+
+  # Unless name is NEW, return a dup singleton instance.
+  def new(name)
+    if name.equal?(NEW)
+      return super
+    end
+
+    instance = @instance.dup
+    instance.name = name
+    instance.failures = []
+    instance
+  end
+
+  # When running the specs in the class, first create a singleton instance, the singleton is
+  # used to implement around_all/before_all/after_all hooks, and each spec will run as a
+  # dup of the singleton instance.
+  def run(reporter, options={})
+    r = nil
+    @instance = new(NEW)
+
+    @instance.around_all do
+      @instance.before_all
+      r = super
+      @instance.after_all
+    end
+    r
+  end
+
+  # If type is :all, set the before_all hook instead of the before hook.
+  def before(type=nil, &block)
+    if type == :all
+      (defined?(@hooks_module) ? @hooks_module : self).send(:define_method, :before_all) do
+        super()
+        instance_exec(&block)
+      end
+      nil
+    else
+      super
+    end
+  end
+
+  # If type is :all, set the after_all hook instead of the after hook.
+  def after(type=nil, &block)
+    if type == :all
+      (defined?(@hooks_module) ? @hooks_module : self).send(:define_method, :after_all) do
+        instance_exec(&block)
+        super()
+      end
+      nil
+    else
+      super
+    end
+  end
+end
+
+# Spec subclass that includes the hook methods.
+class Minitest::HooksSpec < Minitest::Spec
+  include Minitest::Hooks
+end

data/lib/minitest/hooks/default.rb

@@ -0,0 +1,3 @@
+require 'minitest/hooks'
+
+MiniTest::Spec.register_spec_type(//, Minitest::HooksSpec)

data/spec/minitest_hooks_spec.rb

@@ -0,0 +1,111 @@
+require 'rubygems'
+require 'sequel'
+require 'minitest/autorun'
+require 'minitest/hooks/default'
+require 'logger'
+
+DB = Sequel.connect(ENV['DATABASE_URL'] || 'sqlite:/')
+
+describe 'Minitest::Hooks with transactions/savepoints' do
+  before(:all) do
+    @ds_ba = @ds_aa
+    @ds_ba.count.must_equal 1 + @i
+  end
+  before do
+    @ds_be = @ds_ae
+    @ds_be.count.must_equal 2 + @i * 2
+  end
+  after do
+    @ds_be.count.must_equal 2 + @i * 2
+  end
+  after(:all) do
+    @ds_ba.count.must_equal 1 + @i
+  end
+  def around
+    @ds_aa.count.must_equal 1 + @i
+    DB.transaction(:rollback=>:always, :savepoint=>true, :auto_savepoint=>true) do
+      @ds_ae = @ds_aa
+      @ds_ae.insert(1)
+      super
+    end
+    @ds_aa.count.must_equal 1 + @i
+  end
+  def around_all
+    @i ||= 0
+    DB.transaction(:rollback=>:always) do
+      DB.create_table(:a){Integer :a}
+      @ds_aa = DB[:a]
+      @ds_aa.count.must_equal 0
+      @ds_aa.insert(1)
+      super
+    end
+    DB.table_exists?(:a).must_equal false
+  end
+
+  3.times do |i|
+    it "should work try #{i}" do
+      @ds_aa.count.must_equal 2
+      @ds_ae.count.must_equal 2
+      @ds_ba.count.must_equal 2
+      @ds_be.count.must_equal 2
+    end
+  end
+
+  describe "in nested describe" do
+    before(:all) do
+      @ds_ba3 = @ds_ba
+      @ds_ba2 = @ds_aa2
+      @ds_ba2.count.must_equal 2
+    end
+    before do
+      @ds_be3 = @ds_be
+      @ds_be2 = @ds_ae2
+      @ds_be2.count.must_equal 4
+    end
+    after do
+      @ds_be2.count.must_equal 4
+    end
+    after(:all) do
+      @ds_ba2.count.must_equal 2
+    end
+    def around
+      @ds_aa.count.must_equal 2
+      super do
+        @ds_aa.count.must_equal 3
+        @ds_ae3 = @ds_ae
+        @ds_ae2 = @ds_aa2
+        @ds_ae2.insert(1)
+        yield
+        @ds_aa.count.must_equal 4
+      end
+      @ds_aa.count.must_equal 2
+    end
+    def around_all
+      @i ||= 1
+      super do
+        @ds_aa.count.must_equal 1
+        @ds_aa2 = @ds_aa
+        @ds_aa2.insert(1)
+        yield
+        @ds_aa.count.must_equal 2
+      end
+      DB.table_exists?(:a).must_equal false
+    end
+
+    3.times do |i|
+      it "should work try #{i}" do
+        @ds_aa.count.must_equal 4
+        @ds_ae.count.must_equal 4
+        @ds_ba.count.must_equal 4
+        @ds_be.count.must_equal 4
+        @ds_aa2.count.must_equal 4
+        @ds_ae2.count.must_equal 4
+        @ds_ba2.count.must_equal 4
+        @ds_be2.count.must_equal 4
+        @ds_ae3.count.must_equal 4
+        @ds_ba3.count.must_equal 4
+        @ds_be3.count.must_equal 4
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: minitest-hooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: |
+  minitest-hooks adds around and before_all/after_all/around_all hooks for Minitest.
+  This allows you do things like run each suite of specs inside a database transaction,
+  running each spec inside its own savepoint inside that transaction, which can
+  significantly speed up testing for specs that share expensive database setup code.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/minitest/hooks.rb
+- lib/minitest/hooks/default.rb
+- spec/minitest_hooks_spec.rb
+homepage: http://github.com/jeremyevans/minitest_hooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'minitest-hooks: around and before_all/after_all/around_all hooks for Minitest'
+- "--main"
+- README.rdoc
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Around and before_all/after_all/around_all hooks for Minitest
+test_files: []