rspec-sorbet 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfa6e3ee8be246791457ead7ccfadfb915bc17def59dec8f615287e8cbda3aba
+  data.tar.gz: 34c42b3831bc5712a67e544bc56d768c8617e917ede3f2251ad5a22000e50629
+SHA512:
+  metadata.gz: a1b97aa16c1923938827dc55a7e2b8574dd116ed5c88c43530ff47758bee34f9e8b401275b743fb5cd667427307cf0791218d2c33315605da6478798a4f11d48
+  data.tar.gz: 831e6e1f418ac631a7ec9ffc774a682e70ffe7908600d3c20253d6612b4d8d58368e53bcc7c912c10f5b153edab7c9e3825790d7eebb2cb29b0de5b2d0baec95

data/.gitignore

@@ -0,0 +1,19 @@
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/shell.nix
+/tags
+
+*.log
+
+.ruby-gemset

data/.reek.yml

@@ -0,0 +1,32 @@
+---
+detectors:
+  IrresponsibleModule:
+    enabled: false
+  TooManyStatements:
+    enabled: true
+    max_statements: 10
+  NilCheck:
+    enabled: false
+directories:
+  app/controllers:
+    NestedIterators:
+      max_allowed_nesting: 2
+    UnusedPrivateMethod:
+      enabled: false
+  app/helpers:
+    UtilityFunction:
+      enabled: false
+exclude_paths:
+- app/assets
+- bin
+- client/node_modules
+- config
+- coverage
+- data
+- db
+- dw
+- log
+- phrase
+- public
+- tmp
+- vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,66 @@
+---
+Documentation:
+  Enabled: false
+Rails:
+  Enabled: true
+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:
+  Enabled: false
+RSpec/MissingExampleGroupArgument:
+  Enabled: false
+require:
+- rubocop-performance
+- rubocop-rspec
+- test_prof/rubocop
+Metrics/BlockLength:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/ExpectInHook:
+  Enabled: false
+RSpec/AggregateFailures:
+  Enabled: true
+  Include:
+  - spec/**/*.rb
+Rails/InverseOf:
+  Enabled: false
+Rails/Present:
+  Enabled: false
+Rails/TimeZone:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+1.0.0
+
+* Initial release
+* Supports just allowing instance doubles for now

data/Gemfile

@@ -0,0 +1,25 @@
+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'
+  gem 'rubocop-rspec'
+  gem 'shoulda-matchers', require: false
+  gem 'sqlite3'
+  gem 'stackprof'
+  gem 'timecop'
+end
+
+group :test do
+  gem 'ffaker'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Samuel Giles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# RSpec Sorbet
+
+A small gem consisting of helpers for using Sorbet & RSpec together.
+
+## Install
+
+`gem 'rspec-sorbet'`
+
+## Usage
+
+In your `spec_helper.rb` you need to first add a `require`:
+```ruby
+require 'rspec/sorbet'
+```
+
+### Allowing Instance Doubles
+
+Out of the box if your using `instance_double`'s in your tests you'll encounter errors such as the following:
+
+```
+ 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
+```
+
+Drop the following into your `spec_helper.rb` to allow instance doubles to be used:
+
+```ruby
+RSpec::Sorbet.allow_instance_doubles!
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/generate_require_files.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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)
+  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'
+  end
+end
+
+def recursive_files_in(root)
+  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'
+  end
+
+  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|
+    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|
+      file.write("require '#{BASE_FOLDER_PATH}/#{require_directory}/all'\n")
+    end
+    file.write("\n") unless require_directories.empty?
+    require_files.each { |require_file| file.write("require '#{BASE_FOLDER_PATH}/#{require_file[0..-4]}'\n") }
+  end
+end
+
+root = File.join(__dir__, 'lib', BASE_FOLDER_PATH)
+directories = directories_in(root)
+write_require_file(root, directories, files_in(root))
+directories.each do |directory|
+  fully_qualified_directory = File.join(root, directory)
+  write_require_file(fully_qualified_directory, [], recursive_files_in(fully_qualified_directory))
+end

data/lib/rspec/all.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'rspec/sorbet/all'
+
+require 'rspec/sorbet'

data/lib/rspec/sorbet/all.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'rspec/sorbet/instance_doubles'
+require 'rspec/sorbet/version'

data/lib/rspec/sorbet/instance_doubles.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module RSpec
+  module Sorbet
+    module InstanceDoubles
+      WHITELISTED_ERROR_MESSAGES = [
+        'RSpec::Mocks::InstanceVerifyingDouble',
+        'InstanceDouble'
+      ].freeze
+
+      def allow_instance_doubles!
+        T::Configuration.inline_type_error_handler = proc do |error|
+          inline_type_error_handler(error)
+        end
+
+        T::Configuration.call_validation_error_handler = proc do |signature, opts|
+          call_validation_error_handler(signature, opts)
+        end
+      end
+
+      private
+
+      def inline_type_error_handler(error)
+        raise error unless error.is_a?(TypeError) && message_is_whitelisted?(error.message)
+      end
+
+      def call_validation_error_handler(_signature, opts)
+        raise TypeError, opts[:pretty_message] unless message_is_whitelisted?(opts[:message])
+      end
+
+      def message_is_whitelisted?(message)
+        WHITELISTED_ERROR_MESSAGES.any? do |whitelisted_message|
+          message.include?(whitelisted_message)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sorbet/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Sorbet
+    VERSION = '1.0.0'
+  end
+end

data/lib/rspec/sorbet.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec/sorbet/instance_doubles'
+
+module RSpec
+  module Sorbet
+    extend InstanceDoubles
+  end
+end

data/rspec-sorbet.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rspec/sorbet'
+require 'rspec/sorbet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-sorbet'
+  spec.version       = RSpec::Sorbet::VERSION
+  spec.authors       = ['Samuel Giles']
+  spec.email         = ['samuel.giles@bellroy.com']
+
+  spec.summary       = 'A small gem consisting of helpers for using Sorbet & RSpec together.'
+  spec.homepage      = 'https://github.com/tricycle/rspec-sorbet'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec/}) && !f.match(%r{^spec/support/factories/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sorbet'
+  spec.add_dependency 'sorbet-runtime'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sorbet
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Giles
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.giles@bellroy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- generate_require_files.rb
+- lib/rspec/all.rb
+- lib/rspec/sorbet.rb
+- lib/rspec/sorbet/all.rb
+- lib/rspec/sorbet/instance_doubles.rb
+- lib/rspec/sorbet/version.rb
+- rspec-sorbet.gemspec
+homepage: https://github.com/tricycle/rspec-sorbet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A small gem consisting of helpers for using Sorbet & RSpec together.
+test_files: []