rspec-sorbet 1.5.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 132f5432a6a0c56f093437c91e7d34d7d8dd48490713673ad8acb51d74ebded0
-  data.tar.gz: 026b402ed7d3cbd30abd1fce2d65f391abe33e14dff1490b1d6212ab4476d727
+  metadata.gz: 1d35ae78f068312d7be093df0738b370c73b9a9e27e9949230a4fc0abc779c5b
+  data.tar.gz: 2b3d38f4de42ca8ec002160c646c1bf3906cda6066c1603fb7b6da00f30314e9
 SHA512:
-  metadata.gz: 98b4e06ddf4d5c26c02197b8d800ce141fa3a3c30f84bd31f2b824952f78f2498b82a8b133cad74d048fe69b8768653032b33167db9c0c8e6fdae3636f0942eb
-  data.tar.gz: 5a8b24cd86615a4153f01ccbfd706106eabfba4308ab8fbcde1c752216653fdea5229f24ca98a9ba6e74290344850d9828622cdc4d0028d840b259ba42a2c264
+  metadata.gz: 74de415e920f3b98d82460ded292fb392219726e9abad758db444e3324784bbf8ea9d44efc728ef9ec4fd4f771246bf368de85ee956ad4e536b4727b897c30c5
+  data.tar.gz: 56544eab93fb2d158ecfa38111236517c50e70800ddfc694ae0c6b6a6ec0edb88dd3839a8f9987e8169485160db34933acca2ae93d5f540df0e53cbb66e09223

data/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+---
+name: Continuous Integration
+on:
+  push:
+    branches-ignore:
+    - refs/tags/*_staging
+    - refs/tags/*_production
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    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: Cache gems
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/*.gemspec')
+          }}"
+        restore-keys: "${{ runner.OS }}-gem-cache-\n"
+    - uses: "cachix/install-nix-action@8d6d5e949675fbadb765c6b1a975047fa5f09b27"
+      with:
+        extra_nix_config: |
+          post-build-hook = /etc/nix/upload-to-cache.sh
+          substituters = https://cache.nixos.org/
+          trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
+        nix_path: nixpkgs=channel:nixos-21.05
+    - name: Run CI through nix-shell
+      env:
+        GEMFURY_DEPLOY_TOKEN: ${{ secrets.GEMFURY_DEPLOY_TOKEN }}
+      run: nix-shell --run "chmod 755 ./run_ci.sh && ./run_ci.sh"
+    - name: Post to Slack if build fails
+      if: failure() && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+        || github.ref == 'refs/heads/stable')
+      uses: pullreminders/slack-action@a5a262c896a1cc80dcbae59ba95513e2dfb21439
+      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 }]}]}'

data/.gitignore

@@ -7,13 +7,15 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor
 
 # rspec failure tracking
 .rspec_status
 
-/shell.nix
 /tags
 
 *.log
 
 .ruby-gemset
+.direnv
+.envrc

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+1.8.1
+
+* [BUGFIX] Fix processing T.let type mismatch messages when there are digits in module name
+
+1.8.0
+
+* Fixed issues around union types referencing typed enumerables.
+
+1.7.0
+
+* Added support `T.class_of`.
+
+1.6.0
+
+* Non-verifying double support improved.
+
 1.5.0
 
 * Added support for `T.cast`.

data/Gemfile

@@ -8,15 +8,11 @@ group :development, :test do
   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 'tapioca'
 end
 
 group :test do

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/RSpec%20Test%20Suite/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/tricycle/rspec-sorbet/workflows/Continuous%20Integration/badge.svg)
 
 A small gem consisting of helpers for using Sorbet & RSpec together.
 
@@ -30,3 +30,7 @@ Drop the following into your `spec_helper.rb` to allow doubles to be used withou
 ```ruby
 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.

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/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,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 BASE_FOLDER_PATH = 'rspec'

data/lib/rspec/all.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/rspec/sorbet/all.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/rspec/sorbet/doubles.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'sorbet-runtime'
@@ -20,34 +21,49 @@ module RSpec
       private
 
       INLINE_DOUBLE_REGEX =
-        /T.(let|cast): Expected type (T.(any|nilable)\()?(?<expected_classes>[a-zA-Z:: ,]*)(\))?, got type (.*) with value #<(Instance|Class|Object)Double\((?<doubled_module>[a-zA-Z:: ,]*)\)/.freeze
+        /T.(?:let|cast): Expected type (?:T.(?<t_method>any|nilable|class_of)\()?(?<expected_types>[a-zA-Z0-9:: ,]*)(\))?, got (?:type .* with value )?#<(?<double_type>Instance|Class|Object)?Double([\(]|[ ])(?<doubled_type>[a-zA-Z0-9:: ,]*)(\))?/.freeze
 
       def inline_type_error_handler(error)
         case error
         when TypeError
           message = error.message
-          return if double_message_with_ellipsis?(message) || typed_array_message?(message)
+          return if unable_to_check_type_for_message?(message)
 
-          _, expected_types_string, doubled_module_string = (message.match(INLINE_DOUBLE_REGEX) || [])[0..2]
-          raise error unless expected_types_string && doubled_module_string
+          raise error unless (match = message.match(INLINE_DOUBLE_REGEX))
 
-          expected_types = expected_types_string.split(',').map do |expected_type_string|
-            Object.const_get(expected_type_string.strip)
+          t_method = match[:t_method]
+          expected_types = match[:expected_types].split(',').map do |expected_type|
+            Object.const_get(expected_type.strip)
           end
-          doubled_module = Object.const_get(doubled_module_string)
+          double_type = match[:double_type]
+          return if double_type.nil?
+          doubled_type = Object.const_get(match[:doubled_type])
 
-          valid = expected_types.any? do |expected_type|
-            doubled_module.ancestors.include?(expected_type)
+          if double_type == 'Class'
+            raise error if t_method != 'class_of'
+
+            valid = expected_types.any? do |expected_type|
+              doubled_type <= expected_type
+            end
+            raise error unless valid
           end
 
+          valid = expected_types.any? do |expected_type|
+            doubled_type.ancestors.include?(expected_type)
+          end
           raise error unless valid
         else
           raise error
         end
       end
 
+      def unable_to_check_type_for_message?(message)
+        double_message_with_ellipsis?(message) ||
+          typed_array_message?(message)
+      end
+
       VERIFYING_DOUBLE_OR_DOUBLE =
-        /(RSpec::Mocks::(Instance|Class|Object)VerifyingDouble|(Instance|Class|Object)Double)/.freeze
+        /(RSpec::Mocks::(Instance|Class|Object)VerifyingDouble|(Instance|Class|Object)?Double)/.freeze
 
       def double_message_with_ellipsis?(message)
         message.include?('...') && message.match?(VERIFYING_DOUBLE_OR_DOUBLE)
@@ -66,7 +82,9 @@ module RSpec
         if message.match?(VERIFYING_DOUBLE_OR_DOUBLE)
           typing = opts[:type]
           value = opts[:value].is_a?(Array) ? opts[:value].first : opts[:value]
-          target = value.instance_variable_get(:@doubled_module).target
+          target = value.instance_variable_get(:@doubled_module)&.target
+
+          return if target.nil?
 
           case typing
           when T::Types::TypedArray, T::Types::TypedEnumerable
@@ -74,11 +92,15 @@ module RSpec
           end
 
           case typing
+          when T::Types::ClassOf
+            should_raise = !(target <= typing.type)
           when T::Types::Simple
             should_raise = !target.ancestors.include?(typing.raw_type)
           when T::Types::Union
-            valid = typing.types.map(&:raw_type).any? do |type|
-              target.ancestors.include?(type)
+            valid = typing.types.any? do |type|
+              next false unless type.respond_to?(:raw_type)
+
+              target.ancestors.include?(type.raw_type)
             end
             should_raise = !valid
           else

data/lib/rspec/sorbet/version.rb

@@ -1,7 +1,8 @@
+# typed: strict
 # frozen_string_literal: true
 
 module RSpec
   module Sorbet
-    VERSION = '1.5.0'
+    VERSION = '1.8.1'
   end
 end

data/lib/rspec/sorbet.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'rspec/sorbet/doubles'

data/nix/sources.json

@@ -0,0 +1,14 @@
+{
+    "nixpkgs": {
+        "branch": "nixos-21.05",
+        "description": "Nix packages collection",
+        "homepage": "https://github.com/NixOS/nixpkgs",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e85f0175e3effe9ba191d66c09e8f1b7d6362d5e",
+        "sha256": "1qr2hmymbzwj8jrz6smcgc04scgwp2v5070x22k4fvh261g1n4zw",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/e85f0175e3effe9ba191d66c09e8f1b7d6362d5e.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    }
+}

data/nix/sources.nix

@@ -0,0 +1,174 @@
+# This file has been generated by Niv.
+
+let
+
+  #
+  # The fetchers. fetch_<type> fetches specs of type <type>.
+  #
+
+  fetch_file = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchurl { inherit (spec) url sha256; name = name'; }
+      else
+        pkgs.fetchurl { inherit (spec) url sha256; name = name'; };
+
+  fetch_tarball = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
+      else
+        pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
+
+  fetch_git = name: spec:
+    let
+      ref =
+        if spec ? ref then spec.ref else
+          if spec ? branch then "refs/heads/${spec.branch}" else
+            if spec ? tag then "refs/tags/${spec.tag}" else
+              abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!";
+    in
+      builtins.fetchGit { url = spec.repo; inherit (spec) rev; inherit ref; };
+
+  fetch_local = spec: spec.path;
+
+  fetch_builtin-tarball = name: throw
+    ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=tarball -a builtin=true'';
+
+  fetch_builtin-url = name: throw
+    ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=file -a builtin=true'';
+
+  #
+  # Various helpers
+  #
+
+  # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695
+  sanitizeName = name:
+    (
+      concatMapStrings (s: if builtins.isList s then "-" else s)
+        (
+          builtins.split "[^[:alnum:]+._?=-]+"
+            ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name)
+        )
+    );
+
+  # The set of packages used when specs are fetched using non-builtins.
+  mkPkgs = sources: system:
+    let
+      sourcesNixpkgs =
+        import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; };
+      hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
+      hasThisAsNixpkgsPath = <nixpkgs> == ./.;
+    in
+      if builtins.hasAttr "nixpkgs" sources
+      then sourcesNixpkgs
+      else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then
+        import <nixpkgs> {}
+      else
+        abort
+          ''
+            Please specify either <nixpkgs> (through -I or NIX_PATH=nixpkgs=...) or
+            add a package called "nixpkgs" to your sources.json.
+          '';
+
+  # The actual fetching function.
+  fetch = pkgs: name: spec:
+
+    if ! builtins.hasAttr "type" spec then
+      abort "ERROR: niv spec ${name} does not have a 'type' attribute"
+    else if spec.type == "file" then fetch_file pkgs name spec
+    else if spec.type == "tarball" then fetch_tarball pkgs name spec
+    else if spec.type == "git" then fetch_git name spec
+    else if spec.type == "local" then fetch_local spec
+    else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
+    else if spec.type == "builtin-url" then fetch_builtin-url name
+    else
+      abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}";
+
+  # If the environment variable NIV_OVERRIDE_${name} is set, then use
+  # the path directly as opposed to the fetched source.
+  replace = name: drv:
+    let
+      saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
+      ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
+    in
+      if ersatz == "" then drv else
+        # this turns the string into an actual Nix path (for both absolute and
+        # relative paths)
+        if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}";
+
+  # Ports of functions for older nix versions
+
+  # a Nix version of mapAttrs if the built-in doesn't exist
+  mapAttrs = builtins.mapAttrs or (
+    f: set: with builtins;
+    listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))
+  );
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295
+  range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1);
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257
+  stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1));
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
+  stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
+  concatMapStrings = f: list: concatStrings (map f list);
+  concatStrings = builtins.concatStringsSep "";
+
+  # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331
+  optionalAttrs = cond: as: if cond then as else {};
+
+  # fetchTarball version that is compatible between all the versions of Nix
+  builtins_fetchTarball = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchTarball;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchTarball attrs;
+
+  # fetchurl version that is compatible between all the versions of Nix
+  builtins_fetchurl = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchurl;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchurl attrs;
+
+  # Create the final "sources" from the config
+  mkSources = config:
+    mapAttrs (
+      name: spec:
+        if builtins.hasAttr "outPath" spec
+        then abort
+          "The values in sources.json should not have an 'outPath' attribute"
+        else
+          spec // { outPath = replace name (fetch config.pkgs name spec); }
+    ) config.sources;
+
+  # The "config" used by the fetchers
+  mkConfig =
+    { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
+    , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
+    , system ? builtins.currentSystem
+    , pkgs ? mkPkgs sources system
+    }: rec {
+      # The sources, i.e. the attribute set of spec name to spec
+      inherit sources;
+
+      # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers
+      inherit pkgs;
+    };
+
+in
+mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); }

data/rspec-sorbet.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '>= 13.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
 end

data/run_ci.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -e
+rm -f Gemfile.lock
+bundle config gem.fury.io $GEMFURY_DEPLOY_TOKEN
+bundle install
+bundle exec srb tc
+METRICS=1 bundle exec rspec spec

data/shell.nix

@@ -0,0 +1,20 @@
+{ sources ? import ./nix/sources.nix }:
+let
+  nixpkgs = import sources.nixpkgs { };
+in
+nixpkgs.mkShell {
+  name = "bellroy-gem-env";
+  buildInputs = with nixpkgs; [
+    bundler
+    libnotify
+    niv
+    pkg-config
+    readline
+    ruby_2_7
+    zlib
+  ]
+  ++ (if stdenv.hostPlatform.isDarwin then [ libiconv darwin.apple_sdk.frameworks.CoreServices ] else [ ]);
+  shellHook = ''
+    bundle config --local path "$PWD/vendor/bundle"
+  '';
+}

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore
+vendor

data/sorbet/rbi/gems/ast@2.4.2.rbi

@@ -0,0 +1,54 @@
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `ast` gem.
+# Please instead update this file by running `bin/tapioca gem ast`.
+
+# typed: true
+
+module AST; end
+
+class AST::Node
+  def initialize(type, children = T.unsafe(nil), properties = T.unsafe(nil)); end
+
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def deconstruct; end
+  def dup; end
+  def eql?(other); end
+  def hash; end
+  def inspect(indent = T.unsafe(nil)); end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = T.unsafe(nil)); end
+  def to_sexp(indent = T.unsafe(nil)); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = T.unsafe(nil), children = T.unsafe(nil), properties = T.unsafe(nil)); end
+
+  protected
+
+  def assign_properties(properties); end
+  def fancy_type; end
+
+  private
+
+  def original_dup; end
+end
+
+class AST::Processor
+  include ::AST::Processor::Mixin
+end
+
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+
+module AST::Sexp
+  def s(type, *children); end
+end