minitest-suite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14315494c6d4e85d5f6a754070add34121f58dac9499820f1a3936496c71a38e
+  data.tar.gz: 7c5e5da23030fb27f8f4b3a2db983f918ca62a8aae89527bb28b0c78cceafb77
+SHA512:
+  metadata.gz: a4ce626b86e3c40b8091078c9210f18a714d7c67cc1cdcbcbea77f240ca7dfa4014c3280d286cfaaf84cbb44679fa9c7527e4ebe2692a216fc9cbdaf81d468c6
+  data.tar.gz: db057fcf019dbf786c7755b300df0c226cd6cf27c54c5572765ccdd3c0e6731558097efd34ed962a0c30fa248bce45064c6ae4d086dc99625274f08c612978a2

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+- initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    minitest-suite (0.0.1)
+      minitest
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.1.7)
+      rubocop (= 1.18.4)
+      rubocop-performance (= 1.11.4)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  minitest-suite!
+  rake
+  standard
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Test Double, LLC
+
+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,99 @@
+# minitest-suite
+
+The minitest-suite gem modifies the way
+[Minitest](https://github.com/seattlerb/minitest) shuffles the order in which
+`Minitest::Test` subclasses are run by allowing you to organize them into
+sub-suites or groups.
+
+This can be handy when you want to (usually for performance reasons) want to run
+one logical grouping of tests at a time before moving onto the next.
+
+## Using minitest-suite
+
+### Install and setup
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "minitest-suite"
+```
+
+And then require the gem near the top of your test helper:
+
+```ruby
+require "minitest/suite"
+```
+
+### Declaring suites
+
+To associate a test class, just pass a suite name to `suite` in the body of each
+test class:
+
+```ruby
+class SweetTest < Minitest::Test
+  suite :sugary
+
+  def test_blood_sugar
+    #
+  end
+end
+```
+
+Normally, Minitest will shuffle the order of all your test classes. But if
+`minitest-suite` is loaded, your tests will be grouped by any suites you've
+defined: your suites will be shuffled first, then the test classes within each
+of those suites will be shuffled.
+
+For example, suppose you have 4 test classes, two fruits and two vegetables:
+
+```ruby
+class Pumpkin < Minitest::Test
+  suite :veggie
+  def test_it() = puts("🎃")
+end
+
+class Pear < Minitest::Test
+  suite :fruit
+  def test_it() = puts("🍐")
+end
+
+class Pepper < Minitest::Test
+  suite :veggie
+  def test_it() = puts("🌶")
+end
+
+class Apple < Minitest::Test
+  suite :fruit
+  def test_it() = puts("🍎")
+end
+```
+
+By declaring their `suite` above, you're guaranteed the two fruits will run next
+to each other and the two vegetables will run next to each other (even though
+the order will still be randomized):
+
+```
+# Running:
+
+🍐
+.🍎
+.🎃
+.🌶
+.
+```
+
+To wit, the above strategy will ensure you'd never see this test order:
+🍐,🌶,🍎,🎃.
+
+Looking for more? Check out this repo's [example
+test](/example/test/sweet_test.rb).
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+require "bundler/setup"
+require "minitest/suite"
+
+# 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(__FILE__)

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/example/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem "minitest"
+gem "minitest-suite", path: ".."

data/example/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: ..
+  specs:
+    minitest-suite (0.0.1)
+      minitest
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  minitest
+  minitest-suite!
+  rake
+
+BUNDLED WITH
+   2.2.15

data/example/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/example/test/sweet_test.rb

@@ -0,0 +1,74 @@
+CLASS_COUNT = 10
+TEST_COUNT = 10
+
+executions = []
+at_exit do
+  # Everything runs
+  if CLASS_COUNT * TEST_COUNT != executions.size
+    raise "Expected #{CLASS_COUNT * TEST_COUNT} tests to run but was #{executions.size}"
+  end
+
+  suite_order = executions.each_with_object([]) { |exe, memo|
+    memo << exe[:suite] unless memo.last == exe[:suite]
+  }
+  if suite_order.uniq.sort != suite_order.sort
+    raise "Expected each suite to be run contiguously, but was not. Actual suite execution order was: #{suite_order}"
+  end
+
+  puts "Run order:"
+  executions.each.with_index do |execution, i|
+    puts "#{i + 1}. #{execution[:suite]}: #{execution[:class]}##{execution[:method]}"
+  end
+end
+
+require "minitest/suite"
+require "minitest/autorun"
+
+CLASS_COUNT.times do |i|
+  class_name = "TestCase#{i}"
+  Object.const_set(class_name, Class.new(Minitest::Test) {
+    if i <= 2
+      suite_name = :zeroonetwo
+      suite :zeroonetwo
+    elsif i <= 5
+      suite_name = :threefourfive
+      suite :threefourfive
+    elsif i <= 7
+      suite_name = :sixseven
+      Minitest::Suite.register(suite_name: :sixseveneight, test_class: self)
+    else
+      suite_name = :unsuitened
+    end
+
+    TEST_COUNT.times do |j|
+      method_name = "test_#{j}"
+      define_method "test_#{j}" do
+        executions << {
+          class: class_name,
+          method: method_name,
+          suite: suite_name
+        }
+      end
+    end
+  })
+end
+
+class Pumpkin < Minitest::Test
+  suite :veggie
+  def test_it() = puts("🎃")
+end
+
+class Pear < Minitest::Test
+  suite :fruit
+  def test_it() = puts("🍐")
+end
+
+class Pepper < Minitest::Test
+  suite :veggie
+  def test_it() = puts("🌶")
+end
+
+class Apple < Minitest::Test
+  suite :fruit
+  def test_it() = puts("🍎")
+end

data/lib/minitest/suite.rb

@@ -0,0 +1,60 @@
+require_relative "suite/version"
+require "minitest"
+
+module Minitest
+  module Suite
+    class Error < StandardError; end
+
+    def self.register(suite_name:, test_class:)
+      raise Error.new("suite_name must be a Symbol") unless suite_name.is_a?(Symbol)
+      raise Error.new("test_class must be a Minitest::Test") unless test_class.ancestors.include?(Minitest::Test)
+      if (conflicting_suite_name = (suites.keys - [suite_name]).find { |suite_name| suites[suite_name].include?(test_class) })
+        raise Error.new("#{test_class.name || "Class"} is already registered to the #{conflicting_suite_name.inspect} suite")
+      end
+      suites[suite_name] = (suites[suite_name] + [test_class]).uniq
+    end
+
+    def self.suites
+      Thread.current[:minitest_suites] || reset
+    end
+
+    def self.reset
+      Thread.current[:minitest_suites] = Hash.new { [] }
+    end
+
+    class PartialArrayProxy < Array
+      def shuffle
+        suites = (Suite.suites.keys + [:unsuitened]).shuffle
+        suites.flat_map { |suite|
+          if suite == :unsuitened
+            (self - Suite.suites.values.flatten).shuffle
+          else
+            Suite.suites[suite].shuffle
+          end
+        }
+      end
+
+      def reject
+        self.class.new(super)
+      end
+    end
+  end
+end
+
+module Minitest
+  class Test < Runnable
+    def self.suite(suite_name)
+      Minitest::Suite.register(suite_name: suite_name, test_class: self)
+    end
+  end
+
+  class Runnable
+    class << self
+      undef_method :runnables
+      define_method :runnables do
+        return @@runnables if @@runnables.is_a?(Minitest::Suite::PartialArrayProxy)
+        @@runnables = Minitest::Suite::PartialArrayProxy.new(@@runnables)
+      end
+    end
+  end
+end

data/lib/minitest/suite/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Suite
+    VERSION = "0.0.1"
+  end
+end

data/minitest-suite.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/minitest/suite/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minitest-suite"
+  spec.version = Minitest::Suite::VERSION
+  spec.authors = ["Justin Searls"]
+  spec.email = ["searls@gmail.com"]
+
+  spec.summary = "Re-order your Minitest suite into logical sub-suites/groups"
+  spec.homepage = "https://github.com/testdouble/minitest-suite"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minitest"
+end

data/script/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -ex
+
+bundle exec rake
+cd example
+bundle exec rake

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: minitest-suite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/Gemfile
+- example/Gemfile.lock
+- example/Rakefile
+- example/test/sweet_test.rb
+- lib/minitest/suite.rb
+- lib/minitest/suite/version.rb
+- minitest-suite.gemspec
+- script/test
+homepage: https://github.com/testdouble/minitest-suite
+licenses: []
+metadata:
+  homepage_uri: https://github.com/testdouble/minitest-suite
+  source_code_uri: https://github.com/testdouble/minitest-suite
+  changelog_uri: https://github.com/testdouble/minitest-suite/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Re-order your Minitest suite into logical sub-suites/groups
+test_files: []