minitest-around 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27d2dad8452908e2bd9b1f2f5d9a1de2b1fb9439
-  data.tar.gz: d3f652f5b43e308a41dfbfce07de2b8e16c98a8b
+  metadata.gz: 713334daf3b3e114e8d5bf5aa6a4767fe8cfddef
+  data.tar.gz: 4c485989c943ccddc3b3aa515ddc2923a590770a
 SHA512:
-  metadata.gz: a79085997989cd022d7c1a4a32d3cc7eb69daded244e3d0c6b146b18025dd98e412e02d6c3a6c1fe6a7731808da7704db4ff7ed3fdfbca62b470b8b91184b939
-  data.tar.gz: 75e7099b4dbbb8271ef7aee1aa23cfe9175a534b4adf76f9f5f888db75d8add02d4b2049594598193022019501988b78a333a73ff8fd50df4b16def11f10f500
+  metadata.gz: 601fbba788d9d5983ea09cecd1d7658d7ce913636f87014d3691e0a5484e5c07427901f475ff45015bfd50ea0c02edfc7621ec2a49341e31c812c78a0dfab111
+  data.tar.gz: 5d67a70bf24e57b8d3a9e8af8be0e70bbba37b3afec9d14b507d882d43fc4c0bdfb763e547dbdfda43157271ca8f22b45fd34cd5384abe85c719b63c1c6f864c

data/.travis.yml

@@ -1,11 +1,22 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
   - jruby
-  - rbx
+  - jruby-head
+  - rbx-2
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=e2647eb4bb8263157b9d99d9f79a49f8262a7e5ed11b07bdfbd312afdb43c2fa
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: rbx
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2
   fast_finish: true

data/Gemfile

@@ -1,3 +1,7 @@
 source "https://rubygems.org"
 
 gemspec # Specify dependencies in minitest-around.gemspec
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  gem "codeclimate-test-reporter", :group => :test, :require => nil
+end

data/README.md

@@ -1,15 +1,26 @@
+[github]: https://github.com/splattael/minitest-around
+[doc]: http://rubydoc.info/github/splattael/minitest-around/master/file/README.md
+[gem]: https://rubygems.org/gems/minitest-around
+[travis]: https://travis-ci.org/splattael/minitest-around
+[codeclimate]: https://codeclimate.com/github/splattael/minitest-around
+[inchpages]: https://inch-ci.org/github/splattael/minitest-around
+
 # minitest-around
 
-[![Build Status](https://travis-ci.org/splattael/minitest-around.png)](https://travis-ci.org/splattael/minitest-around) [![Inline docs](http://inch-ci.org/github/splattael/minitest-around.png)](http://inch-ci.org/github/splattael/minitest-around)
+[![Travis](https://img.shields.io/travis/splattael/minitest-around.svg?branch=master)][travis]
+[![Gem Version](https://img.shields.io/gem/v/minitest-around.svg)][gem]
+[![Code Climate](https://img.shields.io/codeclimate/github/splattael/minitest-around.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/splattael/minitest-around/badges/coverage.svg)][codeclimate]
+[![Inline docs](https://inch-ci.org/github/splattael/minitest-around.svg?branch=master&style=flat)][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
 
 Around block for minitest 5.X.
 
 Alternative for setup/teardown dance.
 
-[Gem](https://rubygems.org/gems/minitest-around) |
-[Source](https://github.com/splattael/minitest-around) |
-[RDoc](http://rubydoc.info/github/splattael/minitest-around/master/file/README.md)
-
 ## Installation
 
 ```Bash
@@ -40,6 +51,7 @@ end
 
 ### Spec
 
+<!-- example -->
 ```Ruby
 require 'minitest/autorun'
 require 'minitest/around/spec'
@@ -48,7 +60,7 @@ require 'tmpdir'
 describe "inside new directory" do
   around do |test|
     Dir.mktmpdir do |dir|
-      $dir = dir
+      @dir = dir
       Dir.chdir(dir) do
         test.call
       end
@@ -56,10 +68,15 @@ describe "inside new directory" do
   end
 
   it "is in new directory" do
-    assert_equal $dir, Dir.pwd
+    assert_equal @dir, Dir.pwd.sub("/private/var/", "/var/")
   end
 end
 ```
+<!-- example -->
+
+## Multiple before/after blocks
+
+Minitest-around also enables the use of multiple before/after blocks, which normally don't work in minitest.
 
 ## Caveats
 
@@ -85,6 +102,7 @@ for `minitest` 4.7.X support.
 ## [Contributors](https://github.com/splattael/minitest-around/graphs/contributors)
 
 * [Michael Grosser](https://github.com/grosser)
+* [Hendra Uzia](https://github.com/hendrauzia)
 * [Rick Martínez](https://github.com/rickmzp)
 * [Philip Nelson](https://github.com/pnelson)
 
@@ -105,5 +123,7 @@ bundle exec rake test
 ## Release
 
 ```Bash
-rake bump:patch && rake release
+edit lib/minitest/around/version.rb
+git commit
+rake release
 ```

data/Rakefile

@@ -1,9 +1,9 @@
 require 'bundler/setup'
 require 'bundler/gem_tasks'
-require 'bump/tasks'
+require 'cucumber/rake/task'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task :default => [:test, :features]
 
 # Test
 TEST_FILES = FileList.new('test/*_{test,spec}.rb')
@@ -22,6 +22,21 @@ Rake::TestTask.new(:"test:isolated") do |test|
   test.verbose = true
 end
 
+# Examples
+EXAMPLES = FileList["examples/*.rb"]
+desc "Run all examples"
+task :"test:examples" do
+  EXAMPLES.each do |example|
+    sh "bundle", "exec", "ruby", example
+  end
+end
+
+# Features
+Cucumber::Rake::Task.new(:features) do |t|
+  skip_tags = %w[rspec todo].map { |tag| "--tag ~@#{tag}" }.join(" ")
+  t.cucumber_opts = "features #{skip_tags}"
+end
+
 # RDoc
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
@@ -32,12 +47,3 @@ RDoc::Task.new do |rdoc|
   rdoc.options << "--all"
   rdoc.options << "--markup markdown"
 end
-
-# Examples
-EXAMPLES = FileList["examples/*.rb"]
-desc "Run all examples"
-task :"test:examples" do
-  EXAMPLES.each do |example|
-    sh "bundle", "exec", "ruby", example
-  end
-end

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: --tags ~@ignore -f progress

data/examples/chdir_spec.rb

@@ -1,18 +1,3 @@
-require 'minitest/autorun'
-require 'minitest/around/spec'
-require 'tmpdir'
-
-describe "inside new directory" do
-  around do |test|
-    Dir.mktmpdir do |dir|
-      $dir = dir
-      Dir.chdir(dir) do
-        test.call
-      end
-    end
-  end
-
-  it "is in new directory" do
-    assert_equal $dir, Dir.pwd
-  end
-end
+code = File.read("README.md")[%r{<!-- example -->(.*)<!-- example -->}m].split("\n")[2..-3].join("\n")
+puts code
+eval code

data/features/around_spec.feature

@@ -0,0 +1,351 @@
+Feature: `around` hooks
+
+  `around` hooks receive the example as a block argument, extended to behave as
+  a proc. This lets you define code that should be executed before and after the
+  example. Of course, you can do the same thing with `before` and `after` hooks;
+  and it's often cleaner to do so.
+
+  Where `around` hooks shine is when you want to run an example within a block.
+  For instance, if your database library offers a transaction method that
+  receives a block, you can use an `around` to cleanly open and close the
+  transaction around the example.
+
+  **WARNING:** `around` hooks do not share state with the example the way
+  `before` and `after` hooks do. This means that you cannot share instance
+  variables between `around` hooks and examples.
+
+  **WARNING:** Mock frameworks are set up and torn down within the context of
+  running the example. You cannot interact with them directly in `around` hooks.
+
+  Scenario: Use the example as a proc within the block passed to `around()`
+    Given a file named "example_spec.rb" with:
+      """ruby
+      class Database
+        def self.transaction
+          puts "open transaction"
+          yield
+          puts "close transaction"
+        end
+      end
+
+      RSpec.describe "around filter" do
+        around(:example) do |example|
+          Database.transaction(&example)
+        end
+
+        it "gets run in order" do
+          puts "run the example"
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain:
+      """
+      open transaction
+      run the example
+      close transaction
+      """
+
+  Scenario: Invoke the example using `run()`
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "around hook" do
+        around(:example) do |example|
+          puts "around example before"
+          example.run
+          puts "around example after"
+        end
+
+        it "gets run in order" do
+          puts "in the example"
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain:
+      """
+      around example before
+      in the example
+      around example after
+      """
+
+  @rspec
+  Scenario: Access the example metadata
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "something" do
+        around(:example) do |example|
+          puts example.metadata[:foo]
+          example.run
+        end
+
+        it "does something", :foo => "this should show up in the output" do
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "this should show up in the output"
+
+  @rspec
+  Scenario: Define a global `around` hook
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.configure do |c|
+        c.around(:example) do |example|
+          puts "around example before"
+          example.run
+          puts "around example after"
+        end
+      end
+
+      RSpec.describe "around filter" do
+        it "gets run in order" do
+          puts "in the example"
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain:
+      """
+      around example before
+      in the example
+      around example after
+      """
+
+  Scenario: Per example hooks are wrapped by the `around` hook
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "around filter" do
+        around(:example) do |example|
+          puts "around example before"
+          example.run
+          puts "around example after"
+        end
+
+        before(:example) do
+          puts "before example"
+        end
+
+        after(:example) do
+          puts "after example"
+        end
+
+        it "gets run in order" do
+          puts "in the example"
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain:
+      """
+      around example before
+      before example
+      in the example
+      after example
+      around example after
+      """
+
+  @todo
+  Scenario: Context hooks are NOT wrapped by the `around` hook
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "around filter" do
+        around(:example) do |example|
+          puts "around example before"
+          example.run
+          puts "around example after"
+        end
+
+        before(:context) do
+          puts "before context"
+        end
+
+        after(:context) do
+          puts "after context"
+        end
+
+        it "gets run in order" do
+          puts "in the example"
+        end
+      end
+      """
+    When I run `rspec --format progress example_spec.rb`
+    Then the output should contain:
+      """
+      before context
+      around example before
+      in the example
+      around example after
+      .after context
+      """
+
+  @rspec
+  Scenario: Examples run by an `around` block are run in the configured context
+    Given a file named "example_spec.rb" with:
+      """ruby
+      module IncludedInConfigureBlock
+        def included_in_configure_block; true; end
+      end
+
+      RSpec.configure do |c|
+        c.include IncludedInConfigureBlock
+      end
+
+      RSpec.describe "around filter" do
+        around(:example) do |example|
+          example.run
+        end
+
+        it "runs the example in the correct context" do
+          expect(included_in_configure_block).to be_truthy
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "1 example, 0 failure"
+
+  @rspec
+  Scenario: Implicitly pending examples are detected as Not yet implemented
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "implicit pending example" do
+        around(:example) do |example|
+          example.run
+        end
+
+        it "should be detected as Not yet implemented"
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain:
+      """
+      Pending:
+        implicit pending example should be detected as Not yet implemented
+          # Not yet implemented
+      """
+
+
+  @rspec
+  Scenario: Explicitly pending examples are detected as pending
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "explicit pending example" do
+        around(:example) do |example|
+          example.run
+        end
+
+        it "should be detected as pending" do
+          pending
+          fail
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain:
+      """
+        explicit pending example should be detected as pending
+          # No reason given
+      """
+
+  Scenario: Multiple `around` hooks in the same scope
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "if there are multiple around hooks in the same scope" do
+        around(:example) do |example|
+          puts "first around hook before"
+          example.run
+          puts "first around hook after"
+        end
+
+        around(:example) do |example|
+          puts "second around hook before"
+          example.run
+          puts "second around hook after"
+        end
+
+        it "they should all be run" do
+          puts "in the example"
+          expect(1).to eq(1)
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "1 example, 0 failure"
+    And the output should contain:
+      """
+      first around hook before
+      second around hook before
+      in the example
+      second around hook after
+      first around hook after
+      """
+
+  Scenario: `around` hooks in multiple scopes
+    Given a file named "example_spec.rb" with:
+    """ruby
+    RSpec.describe "if there are around hooks in an outer scope" do
+      around(:example) do |example|
+        puts "first outermost around hook before"
+        example.run
+        puts "first outermost around hook after"
+      end
+
+      around(:example) do |example|
+        puts "second outermost around hook before"
+        example.run
+        puts "second outermost around hook after"
+      end
+
+      describe "outer scope" do
+        around(:example) do |example|
+          puts "first outer around hook before"
+          example.run
+          puts "first outer around hook after"
+        end
+
+        around(:example) do |example|
+          puts "second outer around hook before"
+          example.run
+          puts "second outer around hook after"
+        end
+
+        describe "inner scope" do
+          around(:example) do |example|
+            puts "first inner around hook before"
+            example.run
+            puts "first inner around hook after"
+          end
+
+          around(:example) do |example|
+            puts "second inner around hook before"
+            example.run
+            puts "second inner around hook after"
+          end
+
+          it "they should all be run" do
+            puts "in the example"
+          end
+        end
+      end
+    end
+    """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "1 example, 0 failure"
+    And the output should contain:
+    """
+    first outermost around hook before
+    second outermost around hook before
+    first outer around hook before
+    second outer around hook before
+    first inner around hook before
+    second inner around hook before
+    in the example
+    second inner around hook after
+    first inner around hook after
+    second outer around hook after
+    first outer around hook after
+    second outermost around hook after
+    first outermost around hook after
+    """

data/features/step_definitions/around_steps.rb

@@ -0,0 +1,23 @@
+require 'tempfile'
+
+Given(/^a file named "(.*?)" with:$/) do |filename, content|
+  write_test_file(filename, content)
+end
+
+When(/^I run `rspec.*?(\S+)`$/) do |filename|
+  path = path_for(filename)
+  @output = `ruby #{path}`
+end
+
+Then(/^the output should contain:$/) do |content|
+  assert_includes @output, content
+end
+
+Then(/^the output should contain "(.*?)"$/) do |content|
+  # 1 runs, 0 assertions, 0 failures, 0 errors, 0 skips
+  runs = $1 if content =~ /(\d+) examples?/
+  failures = $1 if content =~ /(\d+) failures?/
+  skips = $1 if content =~ /(\d+) pending/
+  content = /#{runs} runs, \d+ assertions, #{failures} failures, 0 errors, #{skips || 0} skips/
+  assert_match content, @output
+end

data/features/support/env.rb

@@ -0,0 +1,48 @@
+require 'minitest/spec'
+
+class MyWorld
+  include Minitest::Assertions
+
+  attr_accessor :assertions
+
+  def initialize
+    self.assertions = 0
+    @temp_pathes = {}
+  end
+
+  def write_test_file(filename, content)
+    # RSpec.describe -> describe
+    content.gsub!("RSpec.describe", "describe")
+    # example.run -> example.call
+    content.gsub!("example.run", "example.call")
+
+    content = <<-RUBY + content
+      require 'minitest/autorun'
+      require "#{File.expand_path("../../../lib/minitest/around/spec", __FILE__)}"
+
+      require 'rspec/expectations/minitest_integration'
+    RUBY
+    write_file(filename, content)
+  end
+
+  def write_file(filename, content)
+    Tempfile.open(filename) do |file|
+      file.write content
+      assoc_tempfile filename, file.path
+    end
+  end
+
+  def path_for(filename)
+    @temp_pathes.fetch(filename)
+  end
+
+  private
+
+  def assoc_tempfile(filename, temp_path)
+    @temp_pathes[filename] = temp_path
+  end
+end
+
+World do
+  MyWorld.new
+end

data/lib/minitest/around.rb

@@ -1,3 +1,10 @@
 require 'minitest/around/version'
 require 'minitest/around/spec'
 require 'minitest/around/unit'
+
+module Minitest
+  module Around
+    # Ugly hack for cucumber/mt5 combo!
+    VERSION = MinitestAround::VERSION
+  end
+end

data/lib/minitest/around/spec.rb

@@ -1,4 +1,4 @@
-require 'minitest'
+require 'minitest/spec'
 
 require 'minitest/around/version'
 require 'minitest/around/unit'
@@ -7,7 +7,7 @@ Minitest::Spec::DSL.class_eval do
   # - resume to call first part
   # - execute test
   # - resume fiber to execute last part
-  def around(&block)
+  def around(*args, &block)
     fib = nil
     before do
       fib = Fiber.new do |context, resume|

data/lib/minitest/around/unit.rb

@@ -1,4 +1,5 @@
-require 'minitest'
+require 'minitest/test'
+
 require 'minitest/around/version'
 
 Minitest::Test.class_eval do

data/lib/minitest/around/version.rb

@@ -1,5 +1,3 @@
-module Minitest
-  module Around
-    VERSION = '0.3.0'
-  end
+module MinitestAround
+  VERSION = '0.3.1'
 end

data/minitest-around.gemspec

@@ -1,6 +1,6 @@
 require './lib/minitest/around/version'
 
-Gem::Specification.new "minitest-around", Minitest::Around::VERSION do |s|
+Gem::Specification.new "minitest-around", MinitestAround::VERSION do |s|
   s.authors     = ["Peter Suschlik"]
   s.email       = ["peter-minitest-around@suschlik.de"]
   s.homepage    = "https://github.com/splattael/minitest-around"
@@ -13,5 +13,6 @@ Gem::Specification.new "minitest-around", Minitest::Around::VERSION do |s|
 
   s.add_development_dependency 'rdoc'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'bump'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'rspec-expectations'
 end

data/test/helper.rb

@@ -1,3 +1,8 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
 require 'bundler/setup'
 require 'tempfile'
 require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-around
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: cucumber
+  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: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -79,7 +93,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/cucumber.yml
 - examples/chdir_spec.rb
+- features/around_spec.feature
+- features/step_definitions/around_steps.rb
+- features/support/env.rb
 - lib/minitest/around.rb
 - lib/minitest/around/spec.rb
 - lib/minitest/around/unit.rb
@@ -110,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Around block for minitest.