rspec-abq 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fcc7527789801cfb1094fee318218a52cab5bd3b0925398bed7dac2b8deb664
-  data.tar.gz: 3701f56451563118b5d7f869606bea912e72b3fb278dd51a89c06a35e26b166d
+  metadata.gz: 4981ef40bdbb50ac4e89c78713e13eb64dfa7527a828b6f748f914bedc6f4f00
+  data.tar.gz: ba3ab95a526e074b75bfdcbe6a5546230b9ee2b23fd4f2f0ec90a8b57ab86dfc
 SHA512:
-  metadata.gz: 36325877c6ba0a9f01c3d445e24008056d6aee6421af09065b87e8e0e30dbf41bf953f622e99eacb41c50cc4277cae3e4f8e8a7bc4cfd85a9d09e8d3c3a88da3
-  data.tar.gz: 0afbd05fff935a8b1b4b2809cc97049609b87ce4a1a0bbacabb42966cbe152483f397c2bd7136a4bc3d6a45721b5ca455a8839cef401739a3c30f67ef92cf61d
+  metadata.gz: ac9cb3808e6fdaf81032bd2cc69ff388e06834f09594e9a0072276951417fe36ef6f5243b1f5edccc755b15603fde75a5261361a7368b40ec1fe01395b95680b
+  data.tar.gz: c5b702af12ad956ee040c45a4e8d7a8a84ab8278315dc1ccb968b681e96577aba986dfd6d39d9a22427985aa47249e0803d4d7f606afb8b427f62b640a2ff5ea

data/README.md

@@ -1,85 +1,42 @@
-# Rspec::Abq
+# RSpec bindings for ABQ
 
-This gem helps you use rspec with abq.
+:globe_with_meridians: [website](https://www.rwx.com/abq)  
+:bird: [@rwx_research](https://twitter.com/rwx_research)  
+:speech_balloon: [discord](https://www.rwx.com/discord)  
+:books: [documentation](https://www.rwx.com/docs/abq)
 
-## Installation
+:octocat: [rwx-research/abq](https://github.com/rwx-research/abq)
 
-Add this line to your application's Gemfile:
+ABQ is a universal test runner that runs test suites in parallel.
+It’s the best tool for splitting test suites into parallel jobs locally or on CI.
 
-```ruby
-group :test do
-    gem 'rspec-core'
-    ...
-    gem 'rspec-abq'
-end
-```
+The `rspec-abq` gem provides the RSpec bindings for ABQ.
 
-And then execute:
+To use ABQ, check out the documentation on [getting started](https://www.rwx.com/docs/abq/getting-started).
 
-```bash
-bundle
-```
+## Demo
 
-## Usage
+Here's a demo of running an RSpec test suite, and then using `abq` to run it in parallel.
+ABQ invokes any test command passed to it, so you can continue using your native test framework CLI with any arguments it supports.
 
-Use the included binary with abq:
+![abq-demo.svg](abq-demo.svg)
 
-```bash
-abq test -- bundle exec rspec
-```
+## Installation
 
-If abq displays "Worker quit before sending protocol version", try adding this line to your application's `spec/spec_helper.rb`:
+Include the `rspec-abq` gem in your `Gemfile`.
+Commonly, it's added under a test group.
 
 ```ruby
-require 'rspec/abq'
+group :test do
+  gem "rspec-abq"
+end
 ```
 
-## Compatibility
-
-This gem is actively tested against
-
-- rubies 2.7-3.1
-- rspecs 3.5-3.12
-
-as well as a handful of rspec plugins:
-
-- rspec-retry 0.6.2
-- capybara 3.36.0
-- selenium-webdriver 4.1.0
-- capybara-inline-screenshot 2.2.1 (see note below)
-
-### Usage with capybara-inline-screenshot (or capybara-screenshot)
-
-#### tldr
-
-1. run rspec with a compatible `--format` option:
-
-    ```sh
-    abq test -- bundle exec rspec --format documentation
-    ```
-
-2. check for screenshots in the worker output
-
-#### What's happening?
-
-By default, rspec-abq only sends rspec-output to the test process. Because of this, custom formatting (e.g. that
-done by capybara-inline-screenshot) is lost.
-
-If you want to enable custom formatting (which will show inline screenshots), enable a
-capybara-inline-screenshot compatible formatter (`progress` or `documentation`). This will output rspec results
-(including screenshots) from the worker processeses.
-
-Note: the test process output will still only have the aggregate results without screenshots.
+See [the docs](https://www.rwx.com/docs/abq/test-frameworks/rspec) for more notes on installation and compatibility with other RSpec libraries.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
-
-### Releasing the gem
-
-use the release script, `./release_gem.rb`
+For working on `rspec-abq` itself, see [DEVELOPMENT.md](DEVELOPMENT.md)
 
 ## Contributing
 

data/lib/rspec/abq/extensions.rb

@@ -119,6 +119,10 @@ module RSpec
         #   or the configured failure exit status (1 by default) if specs
         #   failed.
         def run_specs(example_groups)
+          if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.11.0") && RSpec.world.rspec_is_quitting
+            return exit_code(false)
+          end
+
           if !!ENV[ABQ_GENERATE_MANIFEST]
             # before abq can start workers, it asks for a manifest
             RSpec::Abq::Manifest.write_manifest(example_groups, RSpec.configuration.seed, RSpec.configuration.ordering_registry)

data/lib/rspec/abq/version.rb

@@ -1,6 +1,6 @@
 module RSpec
   module Abq
     # current version!
-    VERSION = "1.1.4"
+    VERSION = "1.2.0"
   end
 end

data/lib/rspec/abq.rb

@@ -145,6 +145,7 @@ module RSpec
     # @return [void]
     def self.setup_extensions_if_enabled!
       return unless enabled?
+      perform_handshake!
       Extensions.setup!
     end
 
@@ -199,6 +200,7 @@ module RSpec
         RSpec.configuration.color_mode = :on
       else
         RSpec.configuration.color = true
+        RSpec.configuration.tty = true
       end
 
       # RSpec only adds a default formatter if there are no formatters.
@@ -252,6 +254,8 @@ module RSpec
       # the target_test_case is the test case the abq worker wants results for
       # @!visibility private
       attr_reader :target_test_case
+
+      alias_method :perform_handshake!, :socket
     end
 
     # pulls next example from the abq worker and sets it to #target_test_case

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rspec-abq
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
+- rwx
 - Ayaz Hafiz
 - Michael Glass
 autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -17,20 +18,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -65,84 +66,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.38.0
+        version: '3.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.38.0
+        version: '3.40'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.2
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.2
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.6.4
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.6.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: capybara-inline-screenshot
   requirement: !ruby/object:Gem::Requirement
@@ -175,8 +176,7 @@ description: RSpec::Abq is an rspec plugin that replaces its ordering with one t
   is controlled by abq. It allows for parallelization of rspec on a single machine
   or across multiple workers.
 email:
-- ayaz@rwx.com
-- me@rwx.com
+- support@rwx.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -208,14 +208,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: RSpec::Abq allows for parallel rspec runs using abq