minitest-hooks 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc5ab13e6ee044a2863034efc3ac937a421a4db7
-  data.tar.gz: 51b6c4ea85b9eb707f89b781e686ccd9cee60fda
+  metadata.gz: f627ec4c18d23a6411e5ca743c1c26ddfc0b7d7c
+  data.tar.gz: bab6646941a54c118f04121ece54b4f21453ed13
 SHA512:
-  metadata.gz: f7574f8634e17b8d0cfb0c44afd963d075263edfce9f0773be50e3b9f7614c6f13787f4b78203b3fde86c045bcb5bb2f968ccb35b8ab734d4169f6c2e40771b3
-  data.tar.gz: 059e6099981202bcc989e42c5f9cee7f02d3fc3af4670a044dbd7f552229e2b3a43943e08aa0e3f4ac8cb4cae05b1799e15dfa729dadb81a8f5c03713487df42
+  metadata.gz: 1b6c79f2546ad32cbeb5b8245a335e762528bfe5b1b2b47b7fddad10908543dbe23f839ab82927f38a7d2c68bc9da330a14b36b025d5a1c142b400c4789bcee0
+  data.tar.gz: d1d67e7620a1faff10d1c1ad104bf0feec27176f3e2cf81ac5f74dd7d2fafdbd667606dde1d06a0ab39d3275d80aa44fdad6107d8507b36d89ba535caf736414

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 1.2.0 (2015-07-02)
+
+* Add minitest/hooks/test file, which doesn't requrie minitest/spec (janko-m) (#9, #10)
+
 === 1.1.0 (2015-05-11)
 
 * Remove unnecessary module inclusion (jeremyevans)

data/README.rdoc

@@ -88,7 +88,7 @@ and have the block call +super+:
 Create a subclass of <tt>Minitest::Test</tt> and include <tt>Minitest::Hooks</tt>,
 and have your test classes subclass from that subclass:
 
-  require 'minitest/hooks'
+  require 'minitest/hooks/test'
   class MyTest < Minitest::Test
     include Minitest::Hooks
   end
@@ -123,6 +123,70 @@ instead of using the spec DSL.  Make sure to call super when overriding the meth
     end
   end
 
+= Behavior
+
+== Hooks Just Define Methods
+
+Just like the before/after hooks supported by minitest, all hooks supported by minitest-hooks
+just define methods on the spec class, there is no magic ("It's just ruby").  This has a
+couple of effects:
+
+1. You cannot define multiple hooks of the same type in the same class.  This is because
+   you cannot have multiple methods with the same name in the same class.  If you define
+   a second hook of the same type in the same class, it will overwrite the previous hook,
+   just like ruby's behavior if you define a method twice in the same class.
+
+2. For around and around(:all) hooks, you should always call super.  If you want a subclass
+   around hook to run inside a superclass around hook, you need to call super in the
+   subclass hook and run the code inside the block you pass to super, then call block.call
+   somewhere inside the super block:
+
+     describe "superclass" do
+       around do |&block|
+         some_outer_method do
+           super(&block)
+         end
+       end
+
+       describe "subclass" do
+         around do |&block|
+           super do
+             some_inner_method do
+               block.call
+             end
+           end
+         end
+       end
+     end
+
+   You do not need to call super for before(:all) or after(:all) hooks. Both before(:all) and
+   after(:all) implicitly call super for you in the method they define, mirroring minitest's
+   behavior for before and after hooks.
+
+3. All hooks share state/instance variables.  So any instance variables you set in before(:all),
+   around(:all), or around are shared with the examples.  Note that after(:all) will only see
+   instance variables set in before(:all) or around(:all), it will not see instance variables
+   set inside examples.
+
+== All Spec Classes are Independent
+
+The way minitest works, all spec classes are indepedent of other spec classes in terms
+of how and when they are executed, even spec classes that are subclasses of other spec
+classes.  This means that for every spec class, the before(:all), after(:all), and
+around(:all) hooks for that class will be executed, even if they were defined in the
+spec's superclass and not in the spec class itself.
+
+So if you have a spec superclass that uses before(:all), and a spec subclass for that
+superclass, the before(:all) in the spec superclass will be run twice, once in the context
+of an instance of the superclass, before executing the superclass's specs, and once in the
+context of an instance of the subclass, before executing the subclass's specs.
+
+== Order of Operations
+
+For each spec class, the around(:all) hooks are run first.  Both before(:all) and after(:all)
+run inside around(:all).  For each spec inside the spec the spec class, around will be called,
+and before and after for each spec will be run inside around.
+
 = License
 
 MIT

data/lib/minitest/hooks.rb

@@ -1,111 +1,6 @@
+require 'minitest/hooks/test'
 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
-      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 around_all hook, otherwise set the around hook.
-  def around(type=nil, &block)
-    meth = type == :all ? :around_all : :around
-    define_method(meth, &block)
-  end
-
-  # If type is :all, set the before_all hook instead of the before hook.
-  def before(type=nil, &block)
-    if type == :all
-     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
-     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

data/lib/minitest/hooks/test.rb

@@ -0,0 +1,107 @@
+require 'minitest'
+
+# 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
+      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(reporter, options)
+      @instance.after_all
+    end
+    r
+  end
+
+  # If type is :all, set the around_all hook, otherwise set the around hook.
+  def around(type=nil, &block)
+    meth = type == :all ? :around_all : :around
+    define_method(meth, &block)
+  end
+
+  # If type is :all, set the before_all hook instead of the before hook.
+  def before(type=nil, &block)
+    if type == :all
+     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
+     define_method(:after_all) do
+        instance_exec(&block)
+        super()
+      end
+      nil
+    else
+      super
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'sequel'
+gem 'minitest'
+require 'minitest/autorun'

data/spec/minitest_hooks_direct_spec.rb

@@ -1,9 +1,5 @@
-require 'rubygems'
-require 'sequel'
-gem 'minitest'
-require 'minitest/autorun'
+require './spec/helper'
 require 'minitest/hooks'
-require 'logger'
 
 NDB = Sequel.connect(ENV['DATABASE_URL'] || 'sqlite:/')
 

data/spec/minitest_hooks_spec.rb

@@ -1,9 +1,5 @@
-require 'rubygems'
-require 'sequel'
-gem 'minitest'
-require 'minitest/autorun'
+require './spec/helper'
 require 'minitest/hooks/default'
-require 'logger'
 
 DB = Sequel.connect(ENV['DATABASE_URL'] || 'sqlite:/')
 

data/spec/minitest_hooks_test.rb

@@ -1,10 +1,5 @@
-require 'rubygems'
-require 'sequel'
-gem 'minitest'
-require 'minitest/autorun'
-require 'minitest/hooks'
-require 'logger'
-
+require './spec/helper'
+require 'minitest/hooks/test'
 
 class MyTest < Minitest::Test
   include Minitest::Hooks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-hooks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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,
@@ -71,6 +85,8 @@ files:
 - Rakefile
 - lib/minitest/hooks.rb
 - lib/minitest/hooks/default.rb
+- lib/minitest/hooks/test.rb
+- spec/helper.rb
 - spec/minitest_hooks_direct_spec.rb
 - spec/minitest_hooks_spec.rb
 - spec/minitest_hooks_test.rb