release 0.6.1 (#297)

* 0.6.1 release

* bump gem version & sorbet-coerce gem version

* Update README to include RelationType doc

* Fix relation type link

Author: Harry Doan

README.md

@@ -73,6 +73,7 @@ We also add following methods to make type-checking more easily:
 - [`find_n`, `first_n`, `last_n`](https://github.com/chanzuckerberg/sorbet-rails#find-first-and-last)
 - [`pluck_to_tstruct`](#pluck_to_tstruct-instead-of-pluck)
 - [`typed_enum`](#enums)
+- [`Model::RelationType`](#relationtype-alias)
 
 #### `pluck_to_tstruct` instead of `pluck`
 
@@ -159,6 +160,22 @@ Generates only typed enum setter & getter:
   def typed_house=(value); end
 ```
 
+#### `RelationType` alias
+
+There are several kinds of relations of a model: `User::ActiveRecord_Relation`, `User::ActiveRecord_AssociationRelation` and `User::ActiveRecord_Associations_CollectionProxy`. Usually the code may need just any relation type. We add a `Model::RelationType` type alias for every model to use it.
+ 
+```ruby
+class User
+  RelationType = T.type_alias do
+    T.any(
+      User::ActiveRecord_Relation,
+      User::ActiveRecord_AssociationRelation,
+      User::ActiveRecord_Associations_CollectionProxy
+    )
+  end
+end
+```
+
 ### Controllers
 ```sh
 ❯ bundle exec  rake rails_rbi:custom
@@ -231,13 +248,16 @@ instructions specify that `sorbet-rails` should be placed in the [`:default`
 group](https://bundler.io/v2.0/guides/groups.html) of the `Gemfile`, not a
 specific environment group (eg. `development` only).
 
-- Relation class: Making the relations available at runtime (they are normally private constants, the gem makes them public)
-  - Examples: `User::ActiveRecord_Relation`, `User::ActiveRecord_AssociationRelation`
-- Model:
+- Model: The gem provides some helper method to a model to make type-checking easier:
   - `find_n`, `first_n`, `last_n`
   - `pluck_to_tstruct`
   - `typed_enum`
-- Controller: using `TypedParams`
+  
+- Model Relation: 
+  - Make relation classes public. By default, relation classes like `User::ActiveRecord_Relation`, `User::ActiveRecord_AssociationRelation` are private
+  - Add type alias, eg `Model::RelationType`, to represents any type of relation of a model.
+
+- Controller: use `TypedParams` to convert controller parameters to a typed structure
 
 In addition to `require`ing `sorbet-rails`, you must also run
 `bundle exec rake rails_rbi:custom`, which will produce the RBI for these runtime features.

sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.6.0"
+  s.version       = "0.6.1"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'parlour', '~> 2.0'
   s.add_dependency 'sorbet-runtime', '>= 0.5'
-  s.add_dependency 'sorbet-coerce', '>= 0.2.3'
+  s.add_dependency 'sorbet-coerce', '>= 0.2.4'
   s.add_dependency 'method_source', '>= 0.9.2'
   s.add_dependency 'parser', '>= 2.7'
 

spec/support/v5.0/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.0)
+    sorbet-rails (0.6.1)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
-      sorbet-coerce (>= 0.2.3)
+      sorbet-coerce (>= 0.2.4)
       sorbet-runtime (>= 0.5)
 
 GEM
@@ -52,7 +52,7 @@ GEM
     ast (2.4.0)
     builder (3.2.4)
     byebug (11.1.1)
-    commander (4.5.0)
+    commander (4.5.2)
       highline (~> 2.0.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
@@ -116,7 +116,7 @@ GEM
     safe_type (1.1.1)
     sorbet (0.5.5420)
       sorbet-static (= 0.5.5420)
-    sorbet-coerce (0.2.3)
+    sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)

spec/support/v5.1/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.0)
+    sorbet-rails (0.6.1)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
-      sorbet-coerce (>= 0.2.3)
+      sorbet-coerce (>= 0.2.4)
       sorbet-runtime (>= 0.5)
 
 GEM
@@ -53,7 +53,7 @@ GEM
     bindex (0.8.1)
     builder (3.2.4)
     byebug (11.1.1)
-    commander (4.5.0)
+    commander (4.5.2)
       highline (~> 2.0.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
@@ -117,7 +117,7 @@ GEM
     safe_type (1.1.1)
     sorbet (0.5.5420)
       sorbet-static (= 0.5.5420)
-    sorbet-coerce (0.2.3)
+    sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)

spec/support/v5.2/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.0)
+    sorbet-rails (0.6.1)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
-      sorbet-coerce (>= 0.2.3)
+      sorbet-coerce (>= 0.2.4)
       sorbet-runtime (>= 0.5)
 
 GEM
@@ -57,7 +57,7 @@ GEM
     bindex (0.8.1)
     builder (3.2.4)
     byebug (11.1.1)
-    commander (4.5.0)
+    commander (4.5.2)
       highline (~> 2.0.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
@@ -125,7 +125,7 @@ GEM
     safe_type (1.1.1)
     sorbet (0.5.5420)
       sorbet-static (= 0.5.5420)
-    sorbet-coerce (0.2.3)
+    sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)

spec/support/v6.0/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.0)
+    sorbet-rails (0.6.1)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
-      sorbet-coerce (>= 0.2.3)
+      sorbet-coerce (>= 0.2.4)
       sorbet-runtime (>= 0.5)
 
 GEM
@@ -70,7 +70,7 @@ GEM
     bindex (0.8.1)
     builder (3.2.4)
     byebug (11.1.1)
-    commander (4.5.0)
+    commander (4.5.2)
       highline (~> 2.0.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
@@ -140,7 +140,7 @@ GEM
     safe_type (1.1.1)
     sorbet (0.5.5420)
       sorbet-static (= 0.5.5420)
-    sorbet-coerce (0.2.3)
+    sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)