rspec-abq 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88c2063493ad3b7115710c2fbd276bb4b08bf6f421804b1e667e617673963cd
-  data.tar.gz: 2feed437fb384a31d8d3bffdd3baa83a5aac9136198723a39b2fe6dc1a28dcea
+  metadata.gz: 1146e666d1067d73f45f4c62a7ec09b7db27d59d949199d23a380635cd24f17a
+  data.tar.gz: 1e61242425452f0cfd6c8f7993e7902be5e4a123a93b4ba4ee6da47b49e368f2
 SHA512:
-  metadata.gz: b36a45217933dbd5a23064aef2562e298a84889bf219669de24a5e4702aebc8d0f056da4d791b823878b93af3b5982457b805d12778ce7842ee821c808cda07c
-  data.tar.gz: 9a0a403f7abed4e50fe4928bbd83449c36d6a206b7eedffb86bc19b8565a1c424fdf05d6ca8c685312f41e0ac29323c6b678f85f85212291b135ce053e6ef0a1
+  metadata.gz: 120a5e036c4157566cbdf707fcde4d7f0404eb768914554abaaba8ed38a9b88ae28dff919b6df0650300c519c8c7504a847e172849e36a5996f9f9792f440bd6
+  data.tar.gz: 23ce430e07de68a261a744139ec7ecc3b596095674a98d0ff4e0ecfbbf9187a6628e308d273ee81530c5e78f31e5388325e47f2cd8043c1b5c13f4daedd87fce

data/README.md

@@ -1,85 +1,42 @@
-# Rspec::Abq
+# RSpec bindings for ABQ
 
-This gem helps you use rspec with abq.
+:globe_with_meridians: [abq.build](https://abq.build)  
+: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/version.rb

@@ -1,6 +1,6 @@
 module RSpec
   module Abq
     # current version!
-    VERSION = "1.1.3"
+    VERSION = "1.1.5"
   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,8 +200,13 @@ 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.
+      # Abq::Formatter is used for internal communication over the ABQ protocol, not for $stdout.
+      RSpec.configuration.add_formatter(RSpec.configuration.default_formatter) if RSpec.configuration.formatters.empty?
+
       RSpec.configuration.add_formatter(RSpec::Abq::Formatter)
 
       # the first message is the init_meta block of the manifest. This is used to share runtime configuration
@@ -248,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-abq
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Ayaz Hafiz
@@ -121,14 +121,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: 2.2.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: 2.2.6.4
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement