aggregate_assertions 0.1.0.pre0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b578ef8e1e9b5cdcdc8da16ad1f01e6b022d786401cf31c0b57bfe7a90e4dc
-  data.tar.gz: ca339ae9a8fa78e2a8d7e46a2d688f9278b146bcdd9511a88934a2530ce044de
+  metadata.gz: '00639ccdafa8ebe12ef425257a24af2e0dfc4e8d76ce3c70fece367f6a6565b7'
+  data.tar.gz: cc5ba9f480daf808165ae61bc5c0786d0014e7f1eab91d5a5c6eaea5fbe34a51
 SHA512:
-  metadata.gz: 56295e2ac81bd5c8ffdb590228c61ba52088e46c0ee0e9e07551554debc0c386c2ee389def6ff28ed326622cd53fbe2161b770b4bc7966ab0478194bec310ca7
-  data.tar.gz: 99769e351cd4ff99f3889dc3631c154b9e91233edf2482768b10ddbd539f0fdcd70faeae09086a6ae191321d985de30c63245f309ab99660b6cb6acdb7b34efa
+  metadata.gz: 4805686e88f29f9b721a02c84fc80f579291b89a403c96ede61d814999a660a0e07a8b85d044b35c1ce210d2a133b1bdadd7bfed583377a5f31b9e893e29f413
+  data.tar.gz: 49a27fe41ce38d2c889c2d827dc5d0556a4e06a0701dde3068308a54e517863895113350b74d89de340555a2712379084e36e60fcb89e041cd726e85373a2583

data/.github/workflows/main.yml

@@ -10,7 +10,9 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.3
+        ruby-version: 2.6.8
         bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake
+    - name: Tests
+      run: bundle exec rake test
+    - name: Rubocop
+      run: bundle exec rubocop

data/.rubocop.yml

@@ -1,7 +1,14 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
   TargetRubyVersion: 2.6
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aggregate_assertions (0.1.0)
+    aggregate_assertions (0.1.0.pre0)
       minitest (~> 5.0)
 
 GEM
@@ -34,6 +34,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   aggregate_assertions!

data/README.md

@@ -1,15 +1,30 @@
-# AggregateAssertions
+# aggregate_assertions
 
-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.
+Aggregate assertions when testing using minitest. Similar to RSpec's [aggregate_failures](https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/aggregating-failures),
+this gem enables the reporting failures from multiple assertions in a single test.
 
-TODO: Delete this and the text above, and describe your gem
+It is possible to use [rspec-expectations](https://github.com/rspec/rspec-expectations) with minitest, but the
+`aggregate_assertions` gem adds this functionality with no dependencies beyond minitest itself when only assertions are
+used.
+
+Normally a test will stop at the first false assertion. Though we might attempt to write tests with a single assertion,
+due to expensive setup it is often necessary, or more convenient, to make multiple assertions within a test.
+
+Using the `aggregate_assertions` method from this gem with a block, all assertions from the block will be grouped and
+reported as a single assertion at the completion of the block. The multiple assertion error that is reported contains
+the messages from all the errors.
+
+The `aggregate_assertions` implementation uses a thread-local variable, so assertions and other errors from different
+threads will still cause a test to fail immediately.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to the test group of your application's Gemfile:
 
 ```ruby
-gem 'aggregate_assertions'
+group "test" do
+  gem "aggregate_assertions"
+end
 ```
 
 And then execute:
@@ -22,7 +37,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use `aggregate_assertions` with a block in the body of a test. An optional label may be specified that will
+be included in any aggregated error message:
+
+```ruby
+def test_response_example
+  response = Struct.new(:status, :headers, :body).new(404, { "Content-Type" => "text/plain" }, "Not Found")
+
+  aggregate_assertions("testing response") do
+    assert_equal(200, response.status)
+    assert_equal("application/json", response.headers["Content-Type"])
+    assert_equal('{"message":"Success"}', response.body)
+  end
+end
+```
+The failure from this test produces the error:
+```
+Failure:
+ExampleTest#test_response_example [test/test_example.rb:5]:
+There were 3 errors in group "testing response":
+    1) /Users/tjwp/git/aggregate_assertions/test/aggregate_assertions_test.rb:8:
+      Expected: 200
+        Actual: 404
+
+    2) /Users/tjwp/git/aggregate_assertions/test/aggregate_assertions_test.rb:9:
+      Expected: "application/json"
+        Actual: "text/plain"
+
+    3) /Users/tjwp/git/aggregate_assertions/test/aggregate_assertions_test.rb:10:
+      Expected: "{\"message\":\"Success\"}"
+        Actual: "Not Found"
+```
 
 ## Development
 
@@ -30,9 +75,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+To check code style, run `bundle exec rubocop`.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aggregate_assertions.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tjwp/aggregate_assertions.
 
 ## License
 

data/aggregate_assertions.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tim Perkins"]
   spec.email         = ["tjwp@users.noreply.github.com"]
 
-  spec.summary       = "Helper method to aggregate assertions for minitest"
+  spec.summary       = "Aggregate Minitest assertions"
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/tjwp/aggregate_assertions"
   spec.license       = "MIT"

data/lib/aggregate_assertions.rb

@@ -9,10 +9,10 @@ module AggregateAssertions
   module TestPatch
     def assert(test, msg = nil)
       super
-    rescue Minitest::Assertion, StandardError => ex
+    rescue Minitest::Assertion, StandardError => e
       raise unless AssertionAggregator.active?
 
-      AssertionAggregator.add_error(ex)
+      AssertionAggregator.add_error(e)
     end
 
     def aggregate_assertions(label = nil)
@@ -22,8 +22,8 @@ module AggregateAssertions
 
       begin
         yield
-      rescue Minitest::Assertion, StandardError => ex
-        AssertionAggregator.add_error(ex)
+      rescue Minitest::Assertion, StandardError => e
+        AssertionAggregator.add_error(e)
       ensure
         failure_group = AssertionAggregator.close_failure_group
       end

data/lib/aggregate_assertions/assertion_aggregator.rb

@@ -11,8 +11,8 @@ module AggregateAssertions
         !store.nil? && !store.empty?
       end
 
-      def add_error(ex)
-        store.last.add_error(ex)
+      def add_error(error)
+        store.last.add_error(error)
       end
 
       def open_failure_group(label = nil)
@@ -38,4 +38,4 @@ module AggregateAssertions
       end
     end
   end
-end
+end

data/lib/aggregate_assertions/error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Minitest
+  # Error raised when multiple assertions are grouped together.
   class MultipleAssertionError < Minitest::Assertion
     attr_reader :location
 
@@ -14,4 +15,4 @@ module Minitest
       @result_label || super
     end
   end
-end
+end

data/lib/aggregate_assertions/failure_group.rb

@@ -14,11 +14,11 @@ module AggregateAssertions
       @other_errors = []
     end
 
-    def add_error(ex)
-      if ex.is_a?(Minitest::Assertion)
-        @failures << ex
+    def add_error(error)
+      if error.is_a?(Minitest::Assertion)
+        @failures << error
       else
-        @other_errors << ex
+        @other_errors << error
       end
     end
 
@@ -70,4 +70,4 @@ module AggregateAssertions
       string.split("\n").map { |str| "#{prefix}#{str}" }.join("\n")
     end
   end
-end
+end

data/lib/aggregate_assertions/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aggregate_assertions
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre0
+  version: 0.1.0
 platform: ruby
 authors:
 - Tim Perkins
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Helper method to aggregate assertions for minitest
+description: Aggregate Minitest assertions
 email:
 - tjwp@users.noreply.github.com
 executables: []
@@ -67,12 +67,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Helper method to aggregate assertions for minitest
+summary: Aggregate Minitest assertions
 test_files: []