aggregate_assertions 0.1.0.pre0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10b578ef8e1e9b5cdcdc8da16ad1f01e6b022d786401cf31c0b57bfe7a90e4dc
+  data.tar.gz: ca339ae9a8fa78e2a8d7e46a2d688f9278b146bcdd9511a88934a2530ce044de
+SHA512:
+  metadata.gz: 56295e2ac81bd5c8ffdb590228c61ba52088e46c0ee0e9e07551554debc0c386c2ee389def6ff28ed326622cd53fbe2161b770b4bc7966ab0478194bec310ca7
+  data.tar.gz: 99769e351cd4ff99f3889dc3631c154b9e91233edf2482768b10ddbd539f0fdcd70faeae09086a6ae191321d985de30c63245f309ab99660b6cb6acdb7b34efa

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+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: 2.7.3
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-17
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aggregate_assertions.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-minitest"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    aggregate_assertions (0.1.0)
+      minitest (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.2)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.14.0)
+      rubocop (>= 0.90, < 2.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  aggregate_assertions!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-minitest
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tim Perkins
+
+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,39 @@
+# AggregateAssertions
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aggregate_assertions`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aggregate_assertions'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aggregate_assertions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/aggregate_assertions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/aggregate_assertions.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/aggregate_assertions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aggregate_assertions"
+  spec.version       = AggregateAssertions::VERSION
+  spec.authors       = ["Tim Perkins"]
+  spec.email         = ["tjwp@users.noreply.github.com"]
+
+  spec.summary       = "Helper method to aggregate assertions for minitest"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/tjwp/aggregate_assertions"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/tjwp/aggregate_assertions/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", "~> 5.0")
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "aggregate_assertions"
+
+# 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/aggregate_assertions.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "minitest"
+require_relative "aggregate_assertions/version"
+require_relative "aggregate_assertions/assertion_aggregator"
+
+module AggregateAssertions
+  # Contains patches to the Minitest::Test class
+  module TestPatch
+    def assert(test, msg = nil)
+      super
+    rescue Minitest::Assertion, StandardError => ex
+      raise unless AssertionAggregator.active?
+
+      AssertionAggregator.add_error(ex)
+    end
+
+    def aggregate_assertions(label = nil)
+      flunk "aggregate_assertions requires a block" unless block_given?
+
+      AssertionAggregator.open_failure_group(label)
+
+      begin
+        yield
+      rescue Minitest::Assertion, StandardError => ex
+        AssertionAggregator.add_error(ex)
+      ensure
+        failure_group = AssertionAggregator.close_failure_group
+      end
+
+      return if failure_group.success?
+
+      raise failure_group.error unless AssertionAggregator.active?
+
+      AssertionAggregator.add_error(failure_group.error)
+    end
+  end
+end
+
+Minitest::Test.prepend(AggregateAssertions::TestPatch)

data/lib/aggregate_assertions/assertion_aggregator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative("error")
+require_relative("failure_group")
+
+module AggregateAssertions
+  # Main entry-point for the interacting with the state of aggregation.
+  module AssertionAggregator
+    class << self
+      def active?
+        !store.nil? && !store.empty?
+      end
+
+      def add_error(ex)
+        store.last.add_error(ex)
+      end
+
+      def open_failure_group(label = nil)
+        initialize_store << FailureGroup.new(label: label, location: location)
+      end
+
+      def close_failure_group
+        store.pop
+      end
+
+      private
+
+      def store
+        Thread.current[:__mt_aggregate]
+      end
+
+      def initialize_store
+        Thread.current[:__mt_aggregate] ||= []
+      end
+
+      def location
+        caller(3, 1).first.sub(/:in .*$/, "")
+      end
+    end
+  end
+end

data/lib/aggregate_assertions/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Minitest
+  class MultipleAssertionError < Minitest::Assertion
+    attr_reader :location
+
+    def initialize(msg = nil, location: nil, result_label: nil)
+      super(msg)
+      @location = location
+      @result_label = result_label
+    end
+
+    def result_label
+      @result_label || super
+    end
+  end
+end

data/lib/aggregate_assertions/failure_group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+module AggregateAssertions
+  # This class is used to aggregates the failures/errors for an aggregate block.
+  class FailureGroup
+    attr_reader :label, :location
+
+    def initialize(location:, label: nil)
+      @location = location
+      @label = label
+      @failures = []
+      @other_errors = []
+    end
+
+    def add_error(ex)
+      if ex.is_a?(Minitest::Assertion)
+        @failures << ex
+      else
+        @other_errors << ex
+      end
+    end
+
+    def error
+      case @failures.size + @other_errors.size
+      when 0
+        nil
+      when 1
+        @failures.first || @other_errors.first
+      else
+        group_error
+      end
+    end
+
+    def success?
+      @failures.empty? && @other_errors.empty?
+    end
+
+    private
+
+    def group_error
+      Minitest::MultipleAssertionError.new(message_for_errors,
+                                           location: location,
+                                           result_label: result_label)
+    end
+
+    def message_for_errors
+      errors = @failures + @other_errors
+      "There were #{errors.size} errors#{group_label}:\n" +
+        errors.map.with_index do |error, index|
+          if error.is_a?(Minitest::Assertion)
+            "    #{index + 1}) #{error.location}:\n#{indent(error.message)}\n"
+          else
+            "    #{index + 1}) #{error.class}: #{error.message}\n#{indent(error.backtrace.first)}\n"
+          end
+        end.join("\n")
+    end
+
+    def group_label
+      label ? " in group #{label.inspect}" : ""
+    end
+
+    def result_label
+      @other_errors.any? ? "Error" : nil
+    end
+
+    def indent(string, size: 6)
+      prefix = (" " * size)
+      string.split("\n").map { |str| "#{prefix}#{str}" }.join("\n")
+    end
+  end
+end

data/lib/aggregate_assertions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AggregateAssertions
+  VERSION = "0.1.0.pre0"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: aggregate_assertions
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre0
+platform: ruby
+authors:
+- Tim Perkins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-17 00:00:00.000000000 Z
+dependencies:
+- !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: Helper method to aggregate assertions for minitest
+email:
+- tjwp@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aggregate_assertions.gemspec
+- bin/console
+- bin/setup
+- lib/aggregate_assertions.rb
+- lib/aggregate_assertions/assertion_aggregator.rb
+- lib/aggregate_assertions/error.rb
+- lib/aggregate_assertions/failure_group.rb
+- lib/aggregate_assertions/version.rb
+homepage: https://github.com/tjwp/aggregate_assertions
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tjwp/aggregate_assertions
+  source_code_uri: https://github.com/tjwp/aggregate_assertions
+  changelog_uri: https://github.com/tjwp/aggregate_assertions/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Helper method to aggregate assertions for minitest
+test_files: []