rspec-sorbet 1.8.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9dec091b4abda0048e4bf484b56811c33a08bfb7db3fc7ee8b94a03e23378c4
-  data.tar.gz: 90d696955efbfa611cf59e8ea5260d38c6e209db279f4dec329d3beef927becf
+  metadata.gz: 1e49df5d697e2d441b06483b44261e8edb5ac59b7003c5356d88d6be106db79e
+  data.tar.gz: 17aebafd7cd92d511915bced0d87279e8a0a271ba4ed593a7cdd465c5514c31c
 SHA512:
-  metadata.gz: 49d3f9d8bf3467e4e5c08a8849180db0a86350573be2fd9502703e6036e3dcb2e7185bc63e162550c87c858c0eec07ed8b45371d11143c7b5ef5c8a19b306bdd
-  data.tar.gz: 83828976655f48b64fe4c6957b2a41ca6323047296a0bdd3c4a6febbef3957c83ea6dc312ee9a1d4e08aa4284f5ae45fc556b64087ff99daf1fff5209566deb6
+  metadata.gz: 0d37e33a3218ebde8de313aa0707c690f1d06c28b04f552dcc6611d09334d52b73a4aeafc50b132fdc7c1266f1a430a2affffc17928857ecebdefa788e081fa6
+  data.tar.gz: 777a239771115649469b1eff69936a5bd64c1815915ee322300028864d44092481d94b637c0b778b85020a965b900af7d3414ab903dc0ee703cd4dfabc18c47d

data/.devcontainer/devcontainer.json

@@ -0,0 +1,5 @@
+{
+	"name": "Ruby",
+	"image": "mcr.microsoft.com/devcontainers/ruby:0-3.1",
+	"postCreateCommand": "bin/setup"
+}

data/.github/workflows/ci.yml

@@ -1,56 +1,24 @@
----
 name: Continuous Integration
-on:
-  push:
-    branches-ignore:
-    - refs/tags/*_staging
-    - refs/tags/*_production
+
+on: push
+
+permissions:
+  contents: read
+
 jobs:
-  build:
-    runs-on: ubuntu-18.04
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1']
     steps:
-    - name: Checkout branch
-      uses: actions/checkout@v2
-    - name: Extract branch name
-      shell: bash
-      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-      id: extract_branch
-    - name: Install Linux dependencies
-      run: sudo apt-get update -qq && sudo apt-get install -y libsqlite3-dev
+    - uses: actions/checkout@v3
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.6
-    - name: Cache gems
-      uses: actions/cache@v2
-      with:
-        path: vendor/bundle
-        key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/rspec-sorbet.gemspec')
-          }}"
-        restore-keys: "${{ runner.OS }}-gem-cache-\n"
-    - name: Install bundler
-      run: (bundler -v | grep "2.1.4") || gem install bundler:2.1.4
-    - name: Remove metrics from bundled gems
-      run: bundle config set without 'metrics'
-    - name: Install gems
-      run: bundle install --jobs $(nproc) --retry 3 --path vendor/bundle
-    - name: Create cache directory
-      run: mkdir -p tmp/cache
-    - name: Typecheck with Sorbet
-      run: bundle exec srb tc . --ignore=/vendor
-    - name: Run RSpec test suite
-      run: bundle exec rspec spec
-      env:
-        METRICS: '1'
-    - name: Post to Slack if build fails
-      if: failure() && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/stable')
-      uses: pullreminders/slack-action@master
-      env:
-        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
-      with:
-        args: '{\"channel\":\"C33574SJJ\",\"text\":\"* ${{ github.repository }} BUILD
-          FAILURE*\", \"attachments\": [{ \"fallback\": \"Failure summary\", \"color\":
-          \"#ff0000\", \"fields\": [{\"title\": \"Branch\", \"value\":\"${{ steps.extract_branch.outputs.branch
-          }}\"}, {\"title\": \"Who broke it\", \"value\":\"${{ github.actor }}\"},
-          { \"title\": \"Build output\", \"value\": \"https://github.com/${{ github.repository
-          }}/commit/${{ github.sha }}/checks\", \"short\": false }]}]}'
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run RSpec tests
+      run: bin/rspec
+    - name: Check for Rubocop offenses
+      run: bin/rubocop --format github

data/.gitignore

@@ -12,9 +12,10 @@
 # rspec failure tracking
 .rspec_status
 
-/shell.nix
 /tags
 
 *.log
 
 .ruby-gemset
+.direnv
+.envrc

data/.rubocop.yml

@@ -1,66 +1,22 @@
----
-Documentation:
-  Enabled: false
-Rails:
-  Enabled: true
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+require: rubocop-rspec
+
 AllCops:
-  Include:
-  - app/**/*.rb
-  - lib/**/*.rb
-  - spec/**/*.rb
-  Exclude:
-  - app/assets/**/*
-  - bin/**/*
-  - client/node_modules/**/*
-  - config/**/*
-  - coverage/**/*
-  - data/**/*
-  - db/**/*
-  - db_*/**/*
-  - dw/**/*
-  - log/**/*
-  - phrase/**/*
-  - public/**/*
-  - tmp/**/*
-  - vendor/**/*
-  TargetRubyVersion: 2.5
-Metrics/LineLength:
-  Max: 100
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%w": "[]"
-RSpec/ExampleLength:
-  Enabled: false
-  Max: 10
-RSpec/MultipleExpectations:
-  Enabled: false
-  Max: 10
-RSpec/NestedGroups:
-  Enabled: false
-  Max: 10
-RSpec/MessageExpectation:
+  NewCops: disable
+  SuggestExtensions: false
+
+RSpec/LeakyConstantDeclaration:
   Enabled: false
-RSpec/MissingExampleGroupArgument:
-  Enabled: false
-require:
-- rubocop-performance
-- rubocop-rspec
-- test_prof/rubocop
-Metrics/BlockLength:
-  Enabled: false
-RSpec/MessageSpies:
-  Enabled: false
-RSpec/ExpectInHook:
+
+RSpec/ExampleLength:
   Enabled: false
-RSpec/AggregateFailures:
-  Enabled: true
-  Include:
-  - spec/**/*.rb
-Rails/InverseOf:
+
+RSpec/NamedSubject:
   Enabled: false
-Rails/Present:
+
+RSpec/MultipleExpectations:
   Enabled: false
-Rails/TimeZone:
+
+RSpec/VerifiedDoubles:
   Enabled: false

data/CHANGELOG.md

@@ -1,41 +1,72 @@
-1.8.0
+# Changelog
 
-* Fixed issues around union types referencing typed enumerables.
+## 1.9.2
 
-1.7.0
+- Rubocop offenses resolved
+- Sorbet signatures added to `RSpec::Sorbet::Doubles`
+- Added `RSpec::Sorbet.reset!` to restore handlers to previous state
+- Added fix to prevent `SystemStackError` by keeping track of when handlers have been configured. (thanks [@alex-tan](https://github.com/alex-tan))
+- Added logic to pass type error onwards to existing inline type error handler.
+- Slimmed down Gem RBIs to minimum needed for `srb tc` to pass in development.
 
-* Added support `T.class_of`.
+## 1.9.1
 
-1.6.0
+- Support `T.nilable(T.class_of(...))` among others (thanks [@deecewan](https://github.com/deecewan))
 
-* Non-verifying double support improved.
+## 1.9.0
 
-1.5.0
+- Allow specification of a custom validation handler (thanks [@bmalinconico](https://github.com/bmalinconico))
 
-* Added support for `T.cast`.
+## 1.8.3
 
-1.4.0
+- Make sorbet a development dependency
 
-* Added support for `T.let` referencing `T.nilable` types.
+## 1.8.2
 
-1.3.0
+- Reduce gem size by excluding RBIs from gem build
 
-* Added ability to allow any kind of double (Class, Instance, Object).
-* `RSpec::Sorbet.allow_instance_doubles!` has been renamed to `RSpec::Sorbet.allow_doubles!`, an alias remains for backwards compatibility for the time being.
+## 1.8.1
 
-1.2.1
+- [BUGFIX] Fix processing T.let type mismatch messages when there are digits in module name
 
-* Fix call check when opts contains :message instead of :pretty_message.
+## 1.8.0
 
-1.2.0
+- Fixed issues around union types referencing typed enumerables.
 
-* Added support for verifying `T::Enumerable` types.
+## 1.7.0
 
-1.1.0
+- Added support `T.class_of`.
 
-* Add basic `instance_double` verification to help check the type of an instance double.
+## 1.6.0
 
-1.0.0
+- Non-verifying double support improved.
 
-* Initial release
-* Supports just allowing instance doubles for now
+## 1.5.0
+
+- Added support for `T.cast`.
+
+## 1.4.0
+
+- Added support for `T.let` referencing `T.nilable` types.
+
+## 1.3.0
+
+- Added ability to allow any kind of double (Class, Instance, Object).
+- `RSpec::Sorbet.allow_instance_doubles!` has been renamed to `RSpec::Sorbet.allow_doubles!`, an alias remains for backwards compatibility for the time being.
+
+## 1.2.1
+
+- Fix call check when opts contains :message instead of :pretty_message.
+
+## 1.2.0
+
+- Added support for verifying `T::Enumerable` types.
+
+## 1.1.0
+
+- Add basic `instance_double` verification to help check the type of an instance double.
+
+## 1.0.0
+
+- Initial release
+- Supports just allowing instance doubles for now

data/Gemfile

@@ -1,25 +1,24 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rspec-sorbet.gemspec
 gemspec
 
 group :development, :test do
-  gem 'guard-livereload', require: false
-  gem 'guard-rspec'
-  gem 'pry-byebug'
-  gem 'rb-fsevent', require: false
-  gem 'rb-readline'
-  gem 'reek'
-  gem 'rspec'
-  gem 'rubocop-rspec'
-  gem 'rubocop'
-  gem 'shoulda-matchers', require: false
-  gem 'sqlite3'
-  gem 'stackprof'
-  gem 'timecop'
+  gem "guard-livereload", require: false
+  gem "guard-rspec"
+  gem "pry-byebug"
+  gem "rb-fsevent", require: false
+  gem "rspec"
+  gem "rubocop-rspec"
+  gem "rubocop-shopify"
+  gem "rubocop"
+  gem "stackprof"
+  gem "tapioca"
 end
 
 group :test do
-  gem 'ffaker'
-  gem 'simplecov'
+  gem "ffaker"
+  gem "rspec-github", require: false
 end

data/README.md

@@ -1,6 +1,6 @@
 ![rspec-sorbet](https://user-images.githubusercontent.com/2643026/63100456-02c12c00-bf6f-11e9-8430-630a27bc6e42.png)
 
-# RSpec Sorbet [![Gem Version](https://badge.fury.io/rb/rspec-sorbet.svg)](https://badge.fury.io/rb/rspec-sorbet) ![CI Badge](https://github.com/tricycle/rspec-sorbet/workflows/Continuous%20Integration/badge.svg)
+# RSpec Sorbet [![Gem Version](https://badge.fury.io/rb/rspec-sorbet.svg)](https://badge.fury.io/rb/rspec-sorbet) ![CI Badge](https://github.com/samuelgiles/rspec-sorbet/workflows/Continuous%20Integration/badge.svg)
 
 A small gem consisting of helpers for using Sorbet & RSpec together.
 
@@ -19,7 +19,7 @@ require 'rspec/sorbet'
 
 Out of the box if you're using `instance_double`, `class_double` or `object_double` in your specs you'll encounter errors such as the following:
 
-```
+```ruby
  TypeError:
        Parameter 'my_parameter': Expected type MyObject, got type RSpec::Mocks::InstanceVerifyingDouble with value #<InstanceDouble(MyObject) (anonymous)>
        Caller: /Users/samuelgiles/Documents/Projects/Clients/Bellroy/bellroy/spec/lib/checkout/use_cases/my_use_case.rb:9
@@ -33,4 +33,17 @@ RSpec::Sorbet.allow_doubles!
 
 ### `eq` matcher usage with `T::Struct`'s
 
-Using the [`eq` matcher](https://www.rubydoc.info/github/rspec/rspec-expectations/RSpec%2FMatchers:eq) to compare [`T::Struct`'s](https://sorbet.org/docs/tstruct) might not behave as you'd expect whereby two separate instances of the same struct class with identical attributes are not `==` out of the box. The standalone [sorbet-struct-comparable](https://github.com/tricycle/sorbet-struct-comparable) gem may be of interest if you are looking for a simple attribute based comparison that will help make the `eq` matcher behave as you expect.
+Using the [`eq` matcher](https://www.rubydoc.info/github/rspec/rspec-expectations/RSpec%2FMatchers:eq) to compare [`T::Struct`'s](https://sorbet.org/docs/tstruct) might not behave as you'd expect whereby two separate instances of the same struct class with identical attributes are not `==` out of the box. The standalone [sorbet-struct-comparable](https://github.com/samuelgiles/sorbet-struct-comparable) gem may be of interest if you are looking for a simple attribute based comparison that will help make the `eq` matcher behave as you expect.
+
+### Specifying a custom validation handler
+
+You can customise the handler of Sorbet validation errors if you so desire.
+
+
+```ruby
+def handler(signature, opts)
+  raise MyCustomException, "The options were #{opts}"
+end
+
+T::Configuration.call_validation_error_handler = handler
+```

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bundler/setup'
-require 'rspec/sorbet'
+require "bundler/setup"
+require "rspec/sorbet"
 
 # 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.
@@ -10,5 +11,5 @@ require 'rspec/sorbet'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/rbi

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bin/tapioca gems rspec-core rspec-expectations rspec-github rspec-support rspec

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/bin/tapioca

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/generate_require_files.rb

@@ -1,35 +1,35 @@
 # typed: true
 # frozen_string_literal: true
 
-BASE_FOLDER_PATH = 'rspec'
+BASE_FOLDER_PATH = "rspec"
 
 def directories_in(root)
   Dir.entries(root).sort.select do |entry|
     fully_qualified_entry = File.join(root, entry)
-    File.directory?(fully_qualified_entry) && !['.', '..'].include?(entry.to_s)
+    File.directory?(fully_qualified_entry) && ![".", ".."].include?(entry.to_s)
   end
 end
 
 def files_in(root)
   Dir.entries(root).sort.reject do |entry|
     fully_qualified_entry = File.join(root, entry)
-    File.directory?(fully_qualified_entry) || entry.to_s == 'all.rb' || entry[-3..-1] != '.rb'
+    File.directory?(fully_qualified_entry) || entry.to_s == "all.rb" || entry[-3..-1] != ".rb"
   end
 end
 
 def recursive_files_in(root)
-  full_paths = Dir.glob(File.join(root, '**', '*')).sort.reject do |entry|
+  full_paths = Dir.glob(File.join(root, "**", "*")).sort.reject do |entry|
     fully_qualified_entry = File.join(root, entry)
-    File.directory?(fully_qualified_entry) || entry[-7..-1] == '/all.rb' || entry[-3..-1] != '.rb'
+    File.directory?(fully_qualified_entry) || entry[-7..-1] == "/all.rb" || entry[-3..-1] != ".rb"
   end
 
-  remove_path = root.split('/')[0..-2].join('/') + '/'
-  full_paths.map { |full_path| full_path.gsub(remove_path, '') }
+  remove_path = root.split("/")[0..-2].join("/") + "/"
+  full_paths.map { |full_path| full_path.gsub(remove_path, "") }
 end
 
 def write_require_file(root, require_directories, require_files)
-  require_file_path = File.join(root, 'all.rb')
-  File.open(require_file_path, 'w') do |file|
+  require_file_path = File.join(root, "all.rb")
+  File.open(require_file_path, "w") do |file|
     file.write("# frozen_string_literal: true\n\n")
     file.write("# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED\n\n")
     require_directories.each do |require_directory|
@@ -40,7 +40,7 @@ def write_require_file(root, require_directories, require_files)
   end
 end
 
-root = File.join(__dir__, 'lib', BASE_FOLDER_PATH)
+root = File.join(__dir__, "lib", BASE_FOLDER_PATH)
 directories = directories_in(root)
 write_require_file(root, directories, files_in(root))
 directories.each do |directory|

data/lib/rspec/all.rb

@@ -3,6 +3,6 @@
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
-require 'rspec/sorbet/all'
+require "rspec/sorbet/all"
 
-require 'rspec/sorbet'
+require "rspec/sorbet"

data/lib/rspec/sorbet/all.rb

@@ -3,5 +3,5 @@
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
-require 'rspec/sorbet/doubles'
-require 'rspec/sorbet/version'
+require "rspec/sorbet/doubles"
+require "rspec/sorbet/version"