minisplit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cddee52373663cfbcdfe137b27ee6c1ceda2db790b489683c7f02808a1cb7cab
+  data.tar.gz: 86a29080cfb2646effd1a49833057f018ae8977af66c9bc73c6e4096b6d42c36
+SHA512:
+  metadata.gz: 4bd17a4f0237f0af5970de000720dc71a316ead957666423ae58a1e2863db4951955e37c14e3942673f378749ee01adcdc992dc8a9c4b4ed0115bda8bd729852
+  data.tar.gz: 7830afe067064eedd4ef346f2f49cbc696b3a60e2cf3832142244f8feda9bdebb9e8e99e24dc2401fb433d5a2024378262a553e9c8b156f8237b64f600e45a46

data/.github/workflows/ruby.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        minisplit_index: [0, 1]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        MINISPLIT_INDEX: ${{ matrix.minisplit_index }}
+        MINISPLIT_TOTAL: 2

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at josh.pencheon@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in minisplit.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    minisplit (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minisplit!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Josh Pencheon
+
+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,78 @@
+# Minisplit ![Build](https://github.com/joshpencheon/minisplit/workflows/Ruby/badge.svg)
+
+Really Simple Splitting of your minitest suite.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minisplit'
+```
+
+In your `test_helper.rb`, add:
+
+```ruby
+# test/test_helper.rb
+require 'minisplit/setup'
+```
+
+## Usage
+
+By default, Minisplit won't affect your test suite in any way.
+
+However, by setting two environment variables, you can split your test suite into partitions that you can run in parallel:
+
+```bash
+# Run the first of four partitions:
+$ MINISPLIT_INDEX=0 MINISPLIT_TOTAL=4 bundle exec rake
+
+# Run the second of four partitions:
+$ MINISPLIT_INDEX=1 MINISPLIT_TOTAL=4 bundle exec rake
+```
+
+### CI
+
+The most likely usecase for Minisplit is to quickly speed up CI builds, without any other supporting infrastructure / services.
+
+For example, GitHub Actions configuration:
+
+```yaml
+test:
+  strategy:
+    matrix:
+      minisplit_index: [0, 1, 2, 3]
+
+  steps:
+  - name: Run tests
+    run: bundle exec rake
+    env:
+      MINISPLIT_INDEX: ${{ matrix.minisplit_index }}
+      MINISPLIT_TOTAL: 4
+
+```
+
+## Things to Note
+
+* There is no queue-based assigning; a deterministic partitioning of all examples is done. This isn't going to give an optimal use of time, but for larger suites with higher parallelism, it should be good enough.
+* This can work alongside Minitest's parallel executor, and Rails' parallel tests. So multi-core CI nodes can still be exploited.
+* Because examples in other partitions are silently skipped, all partitions will report the same number (the total number) of runs. Assertions will be counted correctly.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshpencheon/minisplit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joshpencheon/minisplit/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minisplit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joshpencheon/minisplit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minisplit"
+
+# 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/lib/minisplit.rb

@@ -0,0 +1,36 @@
+require 'zlib'
+
+require "minisplit/version"
+
+module Minisplit
+  class Error < StandardError; end
+
+  module ConditionalRunning
+    def run
+      return super if Minisplit.run?(self)
+
+      Minitest::Result.from(self)
+    end
+  end
+
+  class << self
+    def run?(runnable)
+      split_key_for(runnable) % split_count == current_split
+    end
+
+    private
+
+    def current_split
+      ENV.fetch('MINISPLIT_INDEX', 0).to_i
+    end
+
+    def split_count
+      [ENV.fetch('MINISPLIT_TOTAL', 1).to_i, 1].max
+    end
+
+    def split_key_for(runnable)
+      # Use a non-cryptographic hash function:
+      Zlib.crc32(runnable.name)
+    end
+  end
+end

data/lib/minisplit/setup.rb

@@ -0,0 +1,6 @@
+require 'minitest'
+require_relative '../minisplit'
+
+Minitest::Runnable.runnables.each do |runnable|
+  runnable.prepend(Minisplit::ConditionalRunning)
+end

data/lib/minisplit/version.rb

@@ -0,0 +1,3 @@
+module Minisplit
+  VERSION = "0.1.0"
+end

data/minisplit.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/minisplit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minisplit"
+  spec.version       = Minisplit::VERSION
+  spec.authors       = ["Josh Pencheon"]
+  spec.email         = ["josh.pencheon@googlemail.com"]
+
+  spec.summary       = %q{Really Simple Splitting of your minitest suite.}
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: minisplit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Pencheon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-01 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- josh.pencheon@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minisplit.rb
+- lib/minisplit/setup.rb
+- lib/minisplit/version.rb
+- minisplit.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Really Simple Splitting of your minitest suite.
+test_files: []