diff --git a/README.md b/README.md index bc95af9..986a47d 100644 --- a/README.md +++ b/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 # Caller: /Users/samuelgiles/Documents/Projects/Clients/Bellroy/bellroy/spec/lib/checkout/use_cases/my_use_case.rb:9 @@ -33,7 +33,7 @@ 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 diff --git a/rspec-sorbet.gemspec b/rspec-sorbet.gemspec index 3dccf89..f0b37e0 100644 --- a/rspec-sorbet.gemspec +++ b/rspec-sorbet.gemspec @@ -9,10 +9,10 @@ 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.email = ["sam@samuelgil.es"] spec.summary = "A small gem consisting of helpers for using Sorbet & RSpec together." - spec.homepage = "https://github.com/tricycle/rspec-sorbet" + spec.homepage = "https://github.com/samuelgiles/rspec-sorbet" spec.license = "MIT" # Specify which files should be added to the gem when it is released.