minitest-skip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1beeaeb08a9e7844ad040cac471f79ab749d1742
+  data.tar.gz: b395cc6ac1cf5b94c0d458e5d32c6100790224d5
+SHA512:
+  metadata.gz: 8479b71703443531894bb61bf972e8c90bb17fca2bce90306b8d73eb7a8870d0e6f9631f1a5035ad7cdbfabafbf2fb991654e9e8ea44a7360c8ec6d47e131a5a
+  data.tar.gz: 0afdbd6ce4a8c0660a320b087aa3b456e9d9cc91ba6dc02192e2ac25a057437e559f7fe5dbfd63cf680c6be8a652a5350475a089e053298bd2b6a213d7bde610

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minitest-skip.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Ivan Tse
+
+MIT License
+
+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,82 @@
+# Minitest Skip
+
+This gem provides alternative ways of skipping a test. Normally a skipped test in Minitest looks like:
+
+```ruby
+def test_that_is_flaky
+  skip "Figure out why this flakes"
+end
+```
+
+The gotcha for skipping tests with the `skip` keyword is that the `setup` and `teardown` blocks are still executed. This can be costly for acceptance tests since their setup usually involves starting a browser among other slow things.
+
+This gem will allow you to use methods that begin with `skip_` to mark a test as skipped. It modifies Minitest such that it will recognize these skip methods and correctly report the results.
+
+```ruby
+require "minitest/autorun"
+class TestSkip < Minitest::Test
+  def setup
+    sleep 2 # costly setup block
+  end
+
+  def skip_test_that_is_temporarily_broken
+    # ...
+  end
+end
+
+# ruby test/test_skip.rb
+# Run options: --seed 54134
+
+# # Running:
+
+# S
+
+# Finished in 0.001663s, 601.3537 runs/s, 0.0000 assertions/s.
+
+# 1 runs, 0 assertions, 0 failures, 0 errors, 1 skips
+
+# You have skipped tests. Run with --verbose for details.
+```
+
+This gem also adds `xit` and `xdescribe` if you prefer the spec style syntax for Minitest.
+
+```ruby
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/skip_dsl"
+
+describe "Test" do
+  it "normal" do assert true end
+  xit "skipped" do assert false end
+  xdescribe "All skipped" do
+    it "nested skip" do assert false end
+  end
+end
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-skip'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-skip
+
+And that's it! This is a Minitest plugin which means that it will be autoloaded. In order to use `xit` and `xdescribe`, you also need to `require "minitest/skip_dsl"`.
+
+## Contributing
+
+1. Fork it ( https://github.com/ivantsepp/minitest-skip/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/minitest/skip_dsl.rb

@@ -0,0 +1,54 @@
+require 'minitest/spec'
+
+module Minitest
+  module SkipDSL
+    def xit desc = "anonymous", &block
+      block ||= proc { skip "(no tests defined)" }
+
+      @specs ||= 0
+      @specs += 1
+
+      name = "skip_%04d_%s" % [ @specs, desc ]
+
+      undef_klasses = self.children.reject { |c| c.public_method_defined? name }
+
+      define_method name, &block
+
+      undef_klasses.each do |undef_klass|
+        undef_klass.send :undef_method, name
+      end
+
+      name
+    end
+
+    def nuke_test_methods! # :nodoc:
+      self.public_instance_methods.grep(/^test_|skip_/).each do |name|
+        self.send :undef_method, name
+      end
+    end
+  end
+
+  Spec.extend(SkipDSL)
+end
+
+module Kernel
+  def xdescribe(desc, *additional_desc, &block)
+    stack = Minitest::Spec.describe_stack
+    name  = [stack.last, desc, *additional_desc].compact.join("::")
+    sclas = stack.last || if Class === self && kind_of?(Minitest::Spec::DSL) then
+                            self
+                          else
+                            Minitest::Spec.spec_type desc, *additional_desc
+                          end
+
+    cls = sclas.create name, desc
+
+    stack.push cls
+    cls.singleton_class.send(:define_method, :it, cls.method(:xit))
+    cls.class_eval(&block)
+    stack.pop
+    cls
+  end
+
+  private :xdescribe
+end

data/lib/minitest/skip_plugin.rb

@@ -0,0 +1,22 @@
+module Minitest
+  module SkipPlugin
+    def run(reporter, options = {})
+      super
+      methods_matching(/^skip_/).each do |method_name|
+        test = self.new(method_name)
+        test.time = 0
+
+        skip = Skip.new("Skipped from SkipPlugin")
+        source = test.method(method_name).source_location
+        skip.set_backtrace(["#{source[0]}:#{source[1]}"])
+        test.failures << skip
+
+        reporter.record(test)
+      end
+    end
+  end
+
+  def self.plugin_skip_init(options)
+    Runnable.singleton_class.prepend(SkipPlugin)
+  end
+end

data/minitest-skip.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-skip"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Ivan Tse"]
+  spec.email         = ["ivan.tse1@gmail.com"]
+  spec.summary       = %q{Alternative ways to skip tests in Minitest}
+  spec.description   = %q{Adds skip_* methods and xit/xdescribe spec style methods.}
+  spec.homepage      = "https://github.com/ivantsepp/minitest-skip"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "minitest", "~> 5.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/autorun'

data/test/test_skip_dsl.rb

@@ -0,0 +1,56 @@
+require_relative 'test_helper'
+require 'minitest/skip_dsl'
+
+class TestSkipDSL < Minitest::Test
+
+  def setup
+    @output = StringIO.new("")
+
+    @reporter = Minitest::CompositeReporter.new
+    @reporter << @summary_reporter = Minitest::SummaryReporter.new(@output)
+    @reporter << @progress_reporter = Minitest::ProgressReporter.new(@output)
+    @reporter.start
+  end
+
+  def test_xit
+    test = describe "Test" do
+      it "normal" do assert true end
+      xit "skipped" do assert false end
+    end
+    test.run(@reporter)
+    @reporter.report
+
+    assert_includes @output.string.dup, "2 runs, 1 assertions, 0 failures, 0 errors, 1 skips"
+  end
+
+  def test_xdescribe
+    test = xdescribe "Test" do
+      it "normal" do assert true end
+      xit "skipped" do assert false end
+    end
+    test.run(@reporter)
+    @reporter.report
+
+    assert_includes @output.string.dup, "2 runs, 0 assertions, 0 failures, 0 errors, 2 skips"
+  end
+
+  def test_nested_describes
+    nested_1 = nested_2 = nil
+    test = describe "Test" do
+      it "normal" do assert true end
+      xit "skipped" do assert false end
+      nested_1 = xdescribe "All skipped" do
+        it "nested skip" do assert false end
+        nested_2 = describe "nested describe" do
+          it "nested 2 levels skip" do assert false end
+        end
+      end
+    end
+    test.run(@reporter)
+    nested_1.run(@reporter)
+    nested_2.run(@reporter)
+    @reporter.report
+
+    assert_includes @output.string.dup, "4 runs, 1 assertions, 0 failures, 0 errors, 3 skips"
+  end
+end

data/test/test_skip_methods.rb

@@ -0,0 +1,58 @@
+require_relative 'test_helper'
+
+class TestSkipMethods < Minitest::Test
+
+  def setup
+    @@ran = false
+    @test = Class.new(Minitest::Test) do
+      def skip_test_name
+        @@ran = true
+      end
+    end
+    @output = StringIO.new("")
+
+    @reporter = Minitest::CompositeReporter.new
+    @reporter << @summary_reporter = Minitest::SummaryReporter.new(@output)
+    @reporter << @progress_reporter = Minitest::ProgressReporter.new(@output)
+    @reporter.start
+  end
+
+  def test_run_skip
+    @test.run(@reporter)
+    @reporter.report
+    assert_includes @output.string.dup, "1 runs, 0 assertions, 0 failures, 0 errors, 1 skips"
+  end
+
+  def test_run_skip_verbose
+    Object.const_set("ExampleSkipTest", @test)
+    @progress_reporter.options = { verbose: true }
+    @summary_reporter.options = { verbose: true }
+
+    @test.run(@reporter)
+    @reporter.report
+
+    assert_includes @output.string.dup, "#skip_test_name = 0.00 s = S"
+    assert_includes @output.string.dup, <<-EOM.gsub(/^ {4}/, "")
+      1) Skipped:
+    ExampleSkipTest#skip_test_name [test/test_skip_methods.rb:8]:
+    Skipped from SkipPlugin
+    EOM
+
+  end
+
+  def test_skip_methods_are_recorded
+    @test.run(@reporter)
+    result = @summary_reporter.results.first
+    failure = result.failures.first
+    assert result.skipped?
+    assert_equal Minitest::Skip, failure.error.class
+    assert_equal "Skipped from SkipPlugin", failure.error.message
+    assert_equal "test/test_skip_methods.rb:8", failure.location
+  end
+
+  def test_skip_methods_are_not_executed
+    @test.run(@reporter)
+    refute @@ran, "skip methods should not be executed"
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: minitest-skip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Tse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Adds skip_* methods and xit/xdescribe spec style methods.
+email:
+- ivan.tse1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/skip_dsl.rb
+- lib/minitest/skip_plugin.rb
+- minitest-skip.gemspec
+- test/test_helper.rb
+- test/test_skip_dsl.rb
+- test/test_skip_methods.rb
+homepage: https://github.com/ivantsepp/minitest-skip
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Alternative ways to skip tests in Minitest
+test_files:
+- test/test_helper.rb
+- test/test_skip_dsl.rb
+- test/test_skip_methods.rb