sorbet-rails 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab8c01f01bcf1f1400adb25f52d0a6c35127a206
-  data.tar.gz: ad481caa38ffc63d0ea5159a091ff91503c6f17b
+  metadata.gz: f46a2ecda33e62dbb1410943780827a098f5019d
+  data.tar.gz: fe0478758bf1882d6ef2749d9b1cdf56a96afebd
 SHA512:
-  metadata.gz: 488ffc6eac8fec70207a86a71f13f034b55732df73ea9a3dc0aba4f694fa59eb36f98f52dee3f80267f9437484d9b165360a55b3f0033a81d8f5dd4f2bebb40e
-  data.tar.gz: f82f7455bafb5a375ad65b6c0d725a15e2b4e0df53fbd3a3a69d65d7089571b29afbde8befb569ba4f8f1c66b708258bf6a91dcd5d5cae6bfbaa94f50c260abf
+  metadata.gz: 6a194e4ea66176b304fae0b7bffa5ab1b301ba02d1cc2c9d6697538e45082d1ff0a52a57cc2e9f666764bcbf30a0e62c8498ec4b7c5a6952fb91d7cab506ea09
+  data.tar.gz: 3a2727165b5963f0b9ea9f067053330e00fe829ab5ab3f9ac098319c74e149565d8cf244f297d3aab1706f5a2fc5882a8a1978d88d6b01a7dd1b92ffe7166031

data/.gitignore

@@ -42,36 +42,37 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
 # Rails app
-/spec/support/rails_app/tmp/*
-/spec/support/rails_app/.bundle
+/spec/support/**/tmp/*
+/spec/support/**/.bundle
 
 # Ignore the default SQLite database.
-/spec/support/rails_app/db/*.sqlite3
-/spec/support/rails_app/db/*.sqlite3-journal
+/spec/support/**/db/*.sqlite3
+/spec/support/**/db/*.sqlite3-journal
 
 # Ignore all logfiles and tempfiles.
-/spec/support/rails_app/log/*
-/spec/support/rails_app/tmp/*
-!/spec/support/rails_app/log/.keep
-!/spec/support/rails_app/tmp/.keep
+/spec/support/**/log/*
+/spec/support/**/tmp/*
+!/spec/support/**/log/.keep
+!/spec/support/**/tmp/.keep
 
 # Ignore uploaded files in development
-/spec/support/rails_app/storage/*
-!/spec/support/rails_app/storage/.keep
+/spec/support/**/storage/*
+!/spec/support/**/storage/.keep
 
-/spec/support/rails_app/node_modules
-/spec/support/rails_app/yarn-error.log
+/spec/support/**/node_modules
+/spec/support/**/yarn-error.log
 
-/spec/support/rails_app/public/assets
+/spec/support/**/public/assets
 .byebug_history
 
 # Ignore master key for decrypting credentials and more.
-/spec/support/rails_app/config/master.key
+/spec/support/**/config/master.key
+

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+env:
+  - "RAILS_VERSION=5.1.7"
+  - "RAILS_VERSION=5.2.3"
+rvm:
+- 2.4.3
+- 2.5.0
+before_install:
+- gem install bundler -v 2.0.1 --no-doc
+script:
+- bundle exec rake spec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: XWpjZ+CzAqa9I/S9xJCFoCYJQ3cVp2Dz3DIWNjfC4H4lhxZokGA0FW/dKS2GFj/hadvw9gN5YYshyJegzm5I024QFexRxdBrmlVYCic/gqRIuK7hNp1IFeQJYK4j2s6HFcYnqn1sRT2EJQjdQVG/2+Dmv46xlpEPZH5yVnmQlIln28mYvXjPAjHgOLewgj7QEvt72jASd93X+YT30wGugVK0F+lWG75VFWBECe4kYebyNJZ+REX4aKnejtQwIhERD6vRHge3XZ2HQ0o0AZpqL8xK3ghjSuV3XOes01zvpg0qnsf4YA+ZaIRDmYPpCoWBoVFw2M4AyUUIHH0olojt0kDZvhhanDOk3pAxHaEN1bp0rs8oH5olXFnAXOm+4tls/ZyUPKCX/6UgibMVn99LOIxESx0fCf6N81rlHbD8lczLYDOkatozqoDYykt2I8mErYJjZSntwzRwRATkbWxb8Kgx60arUdWwzWXyNdN2Cz4Y0wnuY59X80/d7IddJoWClk2YSkyJqeASQytR2WfjRUkuCZnxOWjccajwRl5fOkA2md2Ttq92OZktqYaAz0l2FcVrxcPiGi5aQk+t8ygBtJx9ft2DQvyZQ1W8Sxdox06ql/WXDhq5i/gjq/jhN7Uu7Xs3G5UvxL+OO/2YQqy8rqb4IKuYAOLoNFmFDEQoN2Q=
+  gem: sorbet-rails
+  on:
+    tags: true
+    repo: chanzuckerberg/sorbet-rails

data/Gemfile

@@ -4,4 +4,19 @@ gemspec
 
 group :test do
   gem 'simplecov', require: false
+  gem 'codecov', require: false
 end
+
+rails_version = ENV["RAILS_VERSION"] || "default"
+
+rails =
+  case rails_version
+  when "master"
+    {github: "rails/rails"}
+  when "default"
+    ">= 5.2.3"
+  else
+    "~> #{rails_version}"
+  end
+
+gem "rails", rails

data/README.md

@@ -1,48 +1,61 @@
 # sorbet-rails
-A set of tools to make the [Sorbet](https://sorbet.org) type checker work with Ruby on Rails seamlessly.
+[![Gem Version](https://badge.fury.io/rb/sorbet-rails.svg)](https://badge.fury.io/rb/sorbet-rails)
+[![Build Status](https://travis-ci.org/chanzuckerberg/sorbet-rails.svg?branch=master)](https://travis-ci.org/chanzuckerberg/sorbet-rails)
+[![codecov](https://codecov.io/gh/chanzuckerberg/sorbet-rails/branch/master/graph/badge.svg)](https://codecov.io/gh/chanzuckerberg/sorbet-rails)
+
+A set of tools to make the [Sorbet](https://sorbet.org) typechecker work with Ruby on Rails seamlessly.
 
 This gem adds a few Rake tasks to generate Ruby Interface (RBI) files for dynamic methods generated by Rails. It also includes signatures for related Rails classes. The RBI files are added to a `sorbet/rails-rbi/` folder.
 
 ## Initial Setup
 
-1. Install the gem and set up Sorbet, up to being able to run `srb tc`. Follow the steps [here](https://sorbet.org/docs/adopting).
+1. Follow the steps [here](https://sorbet.org/docs/adopting) to set up the latest version of Sorbet, up to being able to run `srb tc`.
+
+2. Add `sorbet-rails` to your Gemfile and install them with Bundler.
+
+```
+# -- Gemfile --
+
+gem 'sorbet-rails'
+```
 
-2. Include the ActiveRecord RBI file:
 ```sh
-  $ srb rbi sorbet-typed
+❯ bundle install
 ```
-3. Generate RBI files for routes and models:
+
+3. Generate RBI files for your routes and models:
 ```sh
-  $ rake rails_rbi:routes
-  $ rake rails_rbi:models
+❯ rake rails_rbi:routes
+❯ rake rails_rbi:models
 ```
+
 4. Auto-upgrade the typecheck level of files:
 ```sh
-  $ srb tc --suggest-typed --typed=strict --error-white-list=7022 --autocorrect
+❯ srb tc --suggest-typed --typed=strict --error-white-list=7022 --autocorrect
 ```
-Because we've generated RBI files for routes and models, a lot more files should be type-checkable now.
+Because we've generated RBI files for routes and models, a lot more files should be typecheckable now.
 
 ## RBI Files
 
-### ActiveRecord RBI
+### ActiveRecord
 
-There is an ActiveRecord RBI file that we vendor with this gem. Run `srb rbi sorbet-typed` to include the provided RBI file in your `sorbet/rbi_list`.
+There is an ActiveRecord RBI file that we vendor with this gem. Sorbet picks up these vendored RBI files automatically. (Please make sure you are running the latest version.)
 
-### Routes RBI
+### Routes
 
 This Rake task generates an RBI file defining `_path` and `_url` methods for all named routes in `routes.rb`:
 ```sh
-  $ rake rails_rbi:routes
+❯ rake rails_rbi:routes
 ```
-### Models RBI
+### Models
 
 This Rake task generates RBI files for all models in the Rails application (all descendants of `ActiveRecord::Base`):
 ```sh
-  $ rake rails_rbi:models
+❯ rake rails_rbi:models
 ```
 You can also regenerate RBI files for specific models:
 ```sh
-  $ rake rails_rbi:models[ModelName,AnotherOne,...]
+❯ rake rails_rbi:models[ModelName,AnotherOne,...]
 ```
 The generation task currently creates the following signatures:
 - Column getters & setters
@@ -51,11 +64,14 @@ The generation task currently creates the following signatures:
 - Named scopes
 - Model relation class
 
+```
+Skip method ... because it is not autogenerated by Rails.
+```
 ## Tips & Tricks
 
-### `find`, `first` and `last` 
+### `find`, `first` and `last`
 
-These 3 methods can either return a single nilable record or an array of records. Sorbet does not allow us to define multiple signatures for a function. It doesn't support defining one function signature that has varying returning value depending on the input parameter type. We opt to define the most commonly used signature for these methods, and monkey-patch new functions for the secondary use case.
+These 3 methods can either return a single nilable record or an array of records. Sorbet does not allow us to define multiple signatures for a function ([except stdlib](https://github.com/chanzuckerberg/sorbet-rails/issues/18)). It doesn't support defining one function signature that has varying returning value depending on the input parameter type. We opt to define the most commonly used signature for these methods, and monkey-patch new functions for the secondary use case.
 
 In short:
 - Use `find`, `first` and `last` to fetch a single record.
@@ -90,12 +106,12 @@ end
 If you wanted to make these changes using [Codemod](https://github.com/facebook/codemod), try these commands:
 ```shell
 # from methods like after_commit do <...> end
-codemod -d app/models/ --extensions rb \
+❯ codemod -d app/models/ --extensions rb \
   '(\s*)(before|after)_(validation|save|create|commit|find|initialize|destroy) do' \
   '\1\2_\3 :\2_\3\n\1def \2_\3'
 
 # from methods like after_commit { <...> }
-codemod -d app/models/ --extensions rb \
+❯ codemod -d app/models/ --extensions rb \
   '(\s*)(before|after)_(validation|save|create|commit|find|initialize|destroy) \{ (.*) \}' \
   '\1\2_\3 :\2_\3\n\1def \2_\3\n\1\1\4\n\1end'
 ```

data/lib/sorbet-rails/model_rbi_formatter.rb

@@ -1,29 +1,20 @@
 # typed: true
 class ModelRbiFormatter
-
-  RUBY_TO_SORBET_TYPE_MAPPING = {
-    boolean: 'T::Boolean',
-    date: 'Date',
-    datetime: 'DateTime',
-    decimal: 'Integer',
-    integer: 'Integer',
-    string: 'String',
-    text: 'String',
-    json: 'Hash',
-    jsonb: 'Hash',
-  }
+  MODEL_RELATION_SHARED_MODULE_SUFFIX = "ModelRelationShared"
+  MODEL_CLASS_MODULE_SUFFIX = "ClassMethods"
+  MODEL_INSTANCE_MODULE_SUFFIX = "InstanceMethods"
 
   def initialize(model_class, available_classes)
     @model_class = model_class
     @available_classes = available_classes
-    @columns_hash = model_class.columns_hash
+    @columns_hash = model_class.table_exists? ? model_class.columns_hash : {}
     @generated_sigs = ActiveSupport::HashWithIndifferentAccess.new
     @generated_class_sigs = ActiveSupport::HashWithIndifferentAccess.new
     @generated_scope_sigs = ActiveSupport::HashWithIndifferentAccess.new
     @generated_querying_sigs = ActiveSupport::HashWithIndifferentAccess.new
     begin
       # Load all dynamic instance methods of this model by instantiating a fake model
-      @model_class.new
+      @model_class.new unless @model_class.abstract_class?
     rescue StandardError
       puts "Note: Unable to create new instance of #{model_class.name}"
     end
@@ -38,33 +29,34 @@ class ModelRbiFormatter
     populate_generated_enum_methods
 
     @buffer = []
-    @buffer << draw_class_header
+    @buffer << draw_file_header_and_base_classes
 
+    @buffer << draw_module_header("#{@model_class.name}::#{MODEL_INSTANCE_MODULE_SUFFIX}")
     @model_class.instance_methods.sort.each do |method_name|
       expected_sig = @generated_sigs[method_name]
       next unless expected_sig.present?
       method_obj = @model_class.instance_method(method_name)
-      draw_method(method_name, method_obj, expected_sig, false)
+      draw_method(method_name, method_obj, expected_sig)
     end
+    @buffer << draw_module_or_class_footer
 
+    @buffer << draw_module_header("#{@model_class.name}::#{MODEL_CLASS_MODULE_SUFFIX}")
     @model_class.methods.sort.each do |method_name|
       expected_sig = @generated_class_sigs[method_name]
       next unless expected_sig.present?
       method_obj = @model_class.method(method_name)
-      draw_method(method_name, method_obj, expected_sig, true)
+      draw_method(method_name, method_obj, expected_sig)
     end
+    @buffer << draw_module_or_class_footer
 
-    @buffer << draw_class_footer
-
-    # <Model>::NamedScope is a fake module added so that when a method is defined
-    # in this module, it'll be added to both the Model class as a class method
-    # and to its relation as an instance method.
+    # <Model>::MODEL_RELATION_SHARED_MODULE_SUFFIX is a fake module added so that
+    # when a method is defined in this module, it'll be added to both the Model class
+    # as a class method and to its relation as an instance method.
     #
-    # We need to define the NamedScope module after the other classes
+    # We need to define the module after the other classes
     # to work around Sorbet loading order bug
     # https://sorbet-ruby.slack.com/archives/CHN2L03NH/p1556065791047300
-    @buffer << "\n"
-    @buffer << draw_named_scope_header
+    @buffer << draw_module_header("#{@model_class.name}::#{MODEL_RELATION_SHARED_MODULE_SUFFIX}")
     # For simplicity, generate both in the same module for now.
     # We don't need to define two fake modules to share methods between <Model> and <Relation>
     ({}.
@@ -72,29 +64,20 @@ class ModelRbiFormatter
       merge(@generated_querying_sigs)
     ).each do |method_name, expected_sig|
       method_obj = @model_class.method(method_name) if @model_class.methods.include?(method_name.to_sym)
-      # this is not a class method because it is added to NamedScope
-      draw_method(method_name, method_obj, expected_sig, false)
+      # this is not a class method because it is added to a module
+      draw_method(method_name, method_obj, expected_sig)
     end
-    @buffer << draw_named_scope_footer
-    @buffer << "\n"
+    @buffer << draw_module_or_class_footer
     @buffer.join("\n")
   end
 
-  def draw_method(method_name, method_obj, expected_sig, is_class_method)
+  def draw_method(method_name, method_obj, expected_sig)
     if !method_obj.present?
       # not very actionable because this could be a method in a newer version of Rails
       # puts "Skip method '#{method_name}' because there is no matching method object."
       return
     end
-    if !is_method_autogenerated?(method_obj)
-      puts "Skip method '#{method_name}' because it is not autogenerated by Rails."
-      return
-    end
-    if !matched_signature?(method_obj, expected_sig)
-      puts "Skip method '#{method_name}' because it has different signature from expected."
-      return
-    end
-    @buffer << generate_method_sig(method_name, expected_sig, is_class_method).indent(2)
+    @buffer << generate_method_sig(method_name, expected_sig).indent(2)
   end
 
   def populate_activerecord_querying_methods
@@ -203,8 +186,8 @@ class ModelRbiFormatter
     # TODO allow people to specify the possible values of polymorphic associations
     assoc_class = assoc_should_be_untyped?(reflection) ? "T.untyped" : reflection.class_name
     relation_class = relation_should_be_untyped?(reflection) ?
-      "ActiveRecord::Relation[T.untyped]" :
-      "#{assoc_class}::Relation"
+      "ActiveRecord::Associations::CollectionProxy[T.untyped]" :
+      "#{assoc_class}::CollectionProxy"
     @generated_sigs.merge!({
       "#{assoc_name}" => { ret: relation_class },
       "#{assoc_name}=" => {
@@ -241,7 +224,7 @@ class ModelRbiFormatter
       reflection.polymorphic?
   end
 
-  def draw_class_header
+  def draw_file_header_and_base_classes
     # We define a custom <ModelName>::Relation class so that it can be extended
     # to contain custom scopes for each models
     <<~MESSAGE
@@ -250,7 +233,13 @@ class ModelRbiFormatter
       # typed: strong
 
       class #{@model_class.name}::Relation < ActiveRecord::Relation
-        include #{@model_class.name}::NamedScope
+        include #{@model_class.name}::#{MODEL_RELATION_SHARED_MODULE_SUFFIX}
+        extend T::Generic
+        Elem = type_member(fixed: #{@model_class.name})
+      end
+
+      class #{@model_class.name}::CollectionProxy < ActiveRecord::Associations::CollectionProxy
+        include #{@model_class.name}::#{MODEL_RELATION_SHARED_MODULE_SUFFIX}
         extend T::Generic
         Elem = type_member(fixed: #{@model_class.name})
       end
@@ -258,26 +247,27 @@ class ModelRbiFormatter
       class #{@model_class.name} < #{@model_class.superclass}
         extend T::Sig
         extend T::Generic
-        extend #{@model_class.name}::NamedScope
+        extend #{@model_class.name}::#{MODEL_RELATION_SHARED_MODULE_SUFFIX}
+        extend #{@model_class.name}::ClassMethods
+        include #{@model_class.name}::InstanceMethods
         Elem = type_template(fixed: #{@model_class.name})
+      end
     MESSAGE
   end
 
-  def draw_class_footer
-    "end"
+  def draw_module_or_class_footer
+    <<~MESSAGE
+      end
+    MESSAGE
   end
 
-  def draw_named_scope_header
+  def draw_module_header(name)
     <<~MESSAGE
-      module #{@model_class.name}::NamedScope
+      module #{name}
         extend T::Sig
     MESSAGE
   end
 
-  def draw_named_scope_footer
-    "end"
-  end
-
   def generate_column_methods(buffer)
     @columns_hash.each do |column_name, column_def|
       buffer << draw_column_methods(column_name, column_def)
@@ -285,44 +275,45 @@ class ModelRbiFormatter
   end
 
   def type_for_column_def(column_def)
-    strict_type = RUBY_TO_SORBET_TYPE_MAPPING[column_def.type] || 'T.untyped'
+    cast_type = ActiveRecord::Base.connection.lookup_cast_type_from_column(column_def)
+    strict_type = active_record_type_to_sorbet_type(cast_type)
+
     if column_def.respond_to?(:array?) && column_def.array?
       strict_type = "T::Array[#{strict_type}]"
     end
     column_def.null ? "T.nilable(#{strict_type})" : strict_type
   end
 
-  def is_method_autogenerated?(method_obj)
-    # check if this method is autogenerated or overridden
-    # Note: sometimes this is a module, sometimes it's an instance of a class
-    return false unless method_obj.source_location.present? # BaseObject
-
-    owner_name = method_obj.owner.to_s
-    source_file = method_obj.source_location[0]
-
-    (
-      [
-        "ActiveRecord::AttributeMethods::GeneratedAttributeMethods",
-        "GeneratedAssociationMethods",
-        "ActiveRecord::Querying",
-        "ActiveRecord::AttributeMethods::PrimaryKey",
-      ].any? { |k| owner_name.include?(k) } ||
-      [
-        "lib/active_record/enum.rb",
-        "lib/active_record/scoping/named.rb",
-      ].any? { |k| source_file.include?(k) }
-    )
-  end
-
-  def matched_signature?(method_obj, generated_method_def)
-    # use parameters reflection to find method arguments
-    actual_params = method_obj.parameters
-    expected_args = generated_method_def[:args] || []
-    expected_params = expected_args.map { |arg| [arg[:arg_type], arg[:name]] }
-    actual_params == expected_params
+  def active_record_type_to_sorbet_type(klass)
+    case klass
+    when ActiveRecord::Type::Boolean
+     "T::Boolean"
+    when ActiveRecord::Type::DateTime
+      DateTime
+    when ActiveRecord::Type::Date
+      Date
+    when ActiveRecord::Type::Decimal
+      BigDecimal
+    when ActiveRecord::Type::Float
+      Float
+    when ActiveRecord::Type::Time
+      Time
+    when ActiveRecord::Type::BigInteger, ActiveRecord::Type::Integer, ActiveRecord::Type::DecimalWithoutScale, ActiveRecord::Type::UnsignedInteger
+      Integer
+    when ActiveRecord::Enum::EnumType, ActiveRecord::Type::Binary, ActiveRecord::Type::String, ActiveRecord::Type::Text
+      String
+    else
+      # Json type is only supported in Rails 5.2.3 and above
+      case
+      when Object.const_defined?('ActiveRecord::Type::Json') && klass.is_a?(ActiveRecord::Type::Json)
+        "T.any(Array, T::Boolean, Float, Hash, Integer, String)"
+      else
+        "T.untyped"
+      end
+    end
   end
 
-  def generate_method_sig(method_name, generated_method_def, is_class_method)
+  def generate_method_sig(method_name, generated_method_def)
     # generated_method_def:
     # {
     # .  ret: <return_type>
@@ -357,11 +348,9 @@ class ModelRbiFormatter
       "returns(#{generated_method_def[:ret]})" :
       "void"
 
-    prefix = is_class_method ? "self." : ""
-
     <<~MESSAGE
       sig { #{param_sig}#{return_type} }
-      def #{prefix}#{method_name}(#{param_def}); end
+      def #{method_name}(#{param_def}); end
     MESSAGE
   end
 end