sorbet-rails 0.5.5.1 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4aa01ecf2a262e021765ef53cdd6d5dbaaa93776c0d45ce991f9e70943eae84
-  data.tar.gz: 3957eb0b707a6615466d102eb7fafc25ab21ec35a6a7b3413629ac2924cda36d
+  metadata.gz: 94d5e7839ac88952e888bdde9ac9ee2c838c7833732a9e5f3af80c2eaf29b62c
+  data.tar.gz: 74d8006e67f5283ba3f8dbdbefc347a49284c31307ad4cbc9a4e5a9986de80a6
 SHA512:
-  metadata.gz: cf331590decda2ee306cecda5bd89b1c603b5cbbfb1000f8dfe13e2ca6277d13269e5916cf9337c855be390da9a09eb0b6dd5e36867425421adeb563f1ffafe4
-  data.tar.gz: 61f5427e41cbee6b74311596b8aa54aa981ddf522692c151ca6db95b0cb5fc409e0ee476aab307b6baf0eb0576f38352c2e6c65be1d1d7bd7ccd28753bc3e5a8
+  metadata.gz: 734626fabb0cd9761597f102b4b626a09c4f6f15663abb776fcdadf044851e4f08cfb7da2e125c1109a115037a79192b16bc9f69f989a789b8c57d55835da8ee
+  data.tar.gz: 9d6dff417e3a1c160055b6880117a333efa0f3a3d6ff4ec8d0d9dce0b9298130857ed97a2e0e9e7d149019dd51b38a349b02302818fa57c47fec06eb8e28e6ab

data/README.md

@@ -9,6 +9,8 @@ This gem adds a few Rake tasks to generate Ruby Interface (RBI) files for dynami
 
 `sorbet-rails` supports Rails 4.2 or later.
 
+**Notice**: From v0.6, we'll stop supporting Rails 4.2. Fixes targeting Rails 4.2 specifically can be merged to v0.5.x branch.
+
 ## Initial Setup
 
 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`.

data/lib/sorbet-rails/config.rb

@@ -48,6 +48,7 @@ module SorbetRails
         :active_record_attribute,
         :active_record_assoc,
         :active_record_finder_methods,
+        :active_record_factory_methods,
         :custom_finder_methods,
         :enumerable_collections,
       ]

data/lib/sorbet-rails/helper_rbi_formatter.rb

@@ -31,6 +31,18 @@ class SorbetRails::HelperRbiFormatter
       end
     end
 
+    if ActionController::Helpers.method_defined?(:helpers)
+      # Adds the `helpers` method that provides access to all methods within the
+      # application's helpers.
+      # https://api.rubyonrails.org/classes/ActionController/Helpers/ClassMethods.html#method-i-helpers
+      @parlour.root.create_module('ActionController::Helpers') do |mod|
+        mod.create_method(
+          'helpers',
+          return_type: "T.all(#{@helpers.join(', ')})"
+        )
+      end
+    end
+
     return @parlour.rbi
   end
 end

data/lib/sorbet-rails/model_plugins/active_record_attribute.rb

@@ -42,7 +42,7 @@ class SorbetRails::ModelPlugins::ActiveRecordAttribute < SorbetRails::ModelPlugi
         attribute_module_rbi.create_method(
           "#{column_name}=",
           parameters: [
-            Parameter.new("value", type: column_type.to_s)
+            Parameter.new("value", type: value_type_for_attr_writer(column_type))
           ],
           return_type: nil,
         )
@@ -61,7 +61,11 @@ class SorbetRails::ModelPlugins::ActiveRecordAttribute < SorbetRails::ModelPlugi
       ActiveRecord::Base.connection.lookup_cast_type_from_column(column_def) :
       column_def.cast_type
 
-    strict_type = active_record_type_to_sorbet_type(cast_type)
+    strict_type =
+      active_record_type_to_sorbet_type(
+        cast_type,
+        time_zone_aware: time_zone_aware_column?(column_def, cast_type),
+      )
 
     if column_def.respond_to?(:array?) && column_def.array?
       strict_type = "T::Array[#{strict_type}]"
@@ -72,25 +76,26 @@ class SorbetRails::ModelPlugins::ActiveRecordAttribute < SorbetRails::ModelPlugi
   sig do
     params(
       # in v4.2, datetime can be TimeZoneConverter
-      klass: T.any(Object, ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter)
+      klass: T.any(Object, ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter),
+      time_zone_aware: T::Boolean,
     ).returns(T.any(String, Class))
   end
-  def active_record_type_to_sorbet_type(klass)
+  def active_record_type_to_sorbet_type(klass, time_zone_aware: false)
     case klass
     when ActiveRecord::Type::Boolean
       "T::Boolean"
-    when ActiveRecord::Type::DateTime
-      DateTime
+    when ActiveRecord::Type::DateTime, ActiveRecord::Type::Time
+      time_zone_aware ? ActiveSupport::TimeWithZone : Time
     when ActiveRecord::Type::Date
       Date
     when ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter
-      klass.klass
+      # if type has already been decorated with TimeZoneConverter, it's probably
+      # a Rails 4.2 datetime column and can be considered a TimeWithZone
+      ActiveSupport::TimeWithZone
     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::Type::Binary, ActiveRecord::Type::String, ActiveRecord::Type::Text
@@ -107,4 +112,41 @@ class SorbetRails::ModelPlugins::ActiveRecordAttribute < SorbetRails::ModelPlugi
       end
     end
   end
+
+  # True if this column is "time zone aware", which means it'll be converted on
+  # access from its original class (e.g. `DateTime`) to something with better
+  # support for time zones (usually `ActiveSupport::TimeWithZone`)
+  sig do
+    params(column_def: T.untyped, cast_type: T.untyped).returns(T::Boolean)
+  end
+  def time_zone_aware_column?(column_def, cast_type)
+    # this private class method returns true if the attribute should be "time
+    # zone aware"; it takes into account various global and model-specific
+    # configuration options as described here:
+    # https://api.rubyonrails.org/classes/ActiveRecord/Timestamp.html
+    #
+    # although it's private, it's better this than trying to reimplement the "is
+    # this attribute tz aware?" logic ourselves
+    @model_class.send(
+      :create_time_zone_conversion_attribute?,
+      column_def.name,
+      cast_type
+    )
+  end
+
+  sig { params(column_type: Object).returns(String) }
+  def value_type_for_attr_writer(column_type)
+    assignable_time_types = [DateTime, Date, Time, ActiveSupport::TimeWithZone].map(&:to_s)
+
+    # it's safe - and convenient - to assign any "time like" object to a time zone
+    # aware attribute because Rails will cast it to a `ActiveSupport::TimeWithZone`
+    # (so rereading the attribute will always return the `TimeWithZone` type)
+    if column_type == ActiveSupport::TimeWithZone
+      "T.any(#{assignable_time_types.join(', ')})"
+    elsif column_type == "T.nilable(ActiveSupport::TimeWithZone)"
+      "T.nilable(T.any(#{assignable_time_types.join(', ')}))"
+    else
+      column_type.to_s
+    end
+  end
 end

data/lib/sorbet-rails/model_plugins/active_record_factory_methods.rb

@@ -0,0 +1,28 @@
+# typed: strict
+require ('sorbet-rails/model_plugins/base')
+class SorbetRails::ModelPlugins::ActiveRecordFactoryMethods < SorbetRails::ModelPlugins::Base
+  # Create methods like `new`, `create`, `create!`, etc.
+  sig { override.params(root: Parlour::RbiGenerator::Namespace).void }
+  def generate(root)
+    model_rbi = root.create_class(self.model_class_name)
+
+    factory_methods = ['create', 'create!', 'new']
+
+    factory_methods.each do |factory_method|
+      add_factory_method(model_rbi, factory_method)
+    end
+  end
+
+  sig { params(model_rbi: Parlour::RbiGenerator::ClassNamespace, method_name: String).void }
+  def add_factory_method(model_rbi, method_name)
+    model_rbi.create_method(
+      method_name,
+      parameters: [
+        Parlour::RbiGenerator::Parameter.new("attributes", type: "T.untyped", default: 'nil'),
+        Parlour::RbiGenerator::Parameter.new("&block", type: "T.untyped")
+      ],
+      return_type: self.model_class_name,
+      class_method: true
+    )
+  end
+end

data/lib/sorbet-rails/model_plugins/enumerable_collections.rb

@@ -36,6 +36,7 @@ class SorbetRails::ModelPlugins::EnumerableCollections < SorbetRails::ModelPlugi
       parameters: [
         Parameter.new("&block", type: "T.proc.params(e: #{self.model_class_name}).void")
       ],
+      return_type: "T::Array[#{self.model_class_name}]",
       implementation: true,
     )
     class_rbi.create_method(

data/lib/sorbet-rails/model_plugins/plugins.rb

@@ -7,6 +7,7 @@ require('sorbet-rails/model_plugins/active_record_named_scope')
 require('sorbet-rails/model_plugins/active_record_attribute')
 require('sorbet-rails/model_plugins/active_record_assoc')
 require('sorbet-rails/model_plugins/active_record_finder_methods')
+require('sorbet-rails/model_plugins/active_record_factory_methods')
 require('sorbet-rails/model_plugins/custom_finder_methods')
 require('sorbet-rails/model_plugins/enumerable_collections')
 require('sorbet-rails/model_plugins/active_storage_methods')
@@ -54,6 +55,8 @@ module SorbetRails::ModelPlugins
       ActiveRecordAssoc
     when :active_record_finder_methods
       ActiveRecordFinderMethods
+    when :active_record_factory_methods
+      ActiveRecordFactoryMethods
     when :custom_finder_methods
       CustomFinderMethods
     when :enumerable_collections

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.5.5.1"
+  s.version       = "0.5.6"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]

data/spec/generators/rails-template.rb

@@ -20,6 +20,15 @@ def add_routes
   route "get 'test/index' => 'test#index'"
 end
 
+def add_environment
+  if ENV["RAILS_VERSION"] == "5.0"
+    # by default, Rails 5.0 treats only `datetime` as a time zone aware type;
+    # this config option brings it in line with all versions up to at least v6.0
+    # and makes our time-related attribute fixtures simpler to maintain
+    environment 'config.active_record.time_zone_aware_types = [:datetime, :time]'
+  end
+end
+
 def create_initializers
   initializer "sorbet_rails.rb", <<~RUBY
     # typed: strict
@@ -99,6 +108,8 @@ def create_models
     class Wand < ApplicationRecord
       include Mythical
 
+      self.skip_time_zone_conversion_for_attributes = [:broken_at]
+
       enum core_type: {
         phoenix_feather: 0,
         dragon_heartstring: 1,
@@ -242,7 +253,7 @@ def create_migrations
           t.string :parent_email
           t.text :notes
 
-          t.timestamps
+          t.timestamps null: false
         end
       end
     end
@@ -281,6 +292,7 @@ def create_migrations
         add_column :wands, :hardness,       :decimal, null: false, precision: 10, scale: 10, default: 5
         add_column :wands, :reflectance,    :decimal, null: false, precision: 10, scale: 0, default: 0.5
         add_column :wands, :broken,         :boolean, null: false, default: false
+        add_column :wands, :broken_at,      :datetime, null: true
         add_column :wands, :chosen_at_date, :date
         add_column :wands, :chosen_at_time, :time
         # JSON column type is only supported on 5.2 or higher
@@ -393,6 +405,7 @@ add_gems
 after_bundle do
   say "Creating application..."
   add_routes
+  add_environment
   create_initializers
   create_lib
   create_helpers

data/spec/generators/sorbet_test_cases.rb

@@ -1,12 +1,29 @@
 # typed: false
 require 'sorbet-runtime'
 
+wand = Wand.first!
 wizard = Wizard.first!
 T.assert_type!(wizard, Wizard)
 
 # -- model columns
 T.assert_type!(wizard.name, T.nilable(String))
 
+# -- time/date columns
+T.assert_type!(wizard.created_at, ActiveSupport::TimeWithZone)
+T.assert_type!(wand.broken_at, T.nilable(Time))
+T.assert_type!(wand.chosen_at_date, T.nilable(Date))
+
+# assert that TZ aware attributes are casted to TimeWithZone after assigning
+wizard.created_at = DateTime.now
+T.assert_type!(wizard.created_at, ActiveSupport::TimeWithZone)
+
+if ENV["RAILS_VERSION"] != "4.2"
+  # note: this is expected to fail in Rails 4.2, because in that version only
+  # `datetime` fields are made time zone aware (so this will have the type
+  # `T.nilable(Time)` instead)
+  T.assert_type!(wand.chosen_at_time, T.nilable(ActiveSupport::TimeWithZone))
+end
+
 # -- model associations
 T.assert_type!(wizard.wand, T.nilable(Wand))
 T.assert_type!(T.must(wizard.wand).wizard, Wizard)

data/spec/sorbet_spec.rb

@@ -20,6 +20,10 @@ RSpec.describe 'sorbet' do
       wizard: harry,
       core_type: :phoenix_feather,
       wood_type: "holly",
+      chosen_at_date: Date.parse('2019-09-01'),
+      chosen_at_time: Time.parse('2019-09-01T09:00:00Z'),
+      broken: true,
+      broken_at: Time.parse('2019-09-05T15:30:00Z'),
     )
   end
 

data/spec/support/v4.2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.5.5)
+    sorbet-rails (0.5.6)
       parlour (~> 0.8.0)
 
 GEM
@@ -95,10 +95,10 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    sorbet (0.4.4755)
-      sorbet-static (= 0.4.4755)
-    sorbet-runtime (0.4.4755)
-    sorbet-static (0.4.4755-x86_64-linux)
+    sorbet (0.4.4761)
+      sorbet-static (= 0.4.4761)
+    sorbet-runtime (0.4.4761)
+    sorbet-static (0.4.4761-universal-darwin-14)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/spec/support/v4.2/app/models/wand.rb

@@ -2,6 +2,8 @@
 class Wand < ApplicationRecord
   include Mythical
 
+  self.skip_time_zone_conversion_for_attributes = [:broken_at]
+
   enum core_type: {
     phoenix_feather: 0,
     dragon_heartstring: 1,

data/spec/support/v4.2/app/models/wizard.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: strict
 class Wizard < ApplicationRecord
   validates :name, length: { minimum: 5 }, presence: true
 

data/spec/support/v4.2/config/initializers/sorbet_rails.rb

@@ -1,3 +1,3 @@
-# typed: strict
+# typed: false
 require(Rails.root.join('lib/mythical_rbi_plugin'))
 SorbetRails::ModelRbiFormatter.register_plugin(MythicalRbiPlugin)

data/spec/support/v4.2/db/migrate/20190620000001_create_wizards.rb

@@ -7,7 +7,7 @@ class CreateWizards < ActiveRecord::Migration
       t.string :parent_email
       t.text :notes
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/spec/support/v4.2/db/migrate/20190620000004_add_more_column_types_to_wands.rb

@@ -5,6 +5,7 @@ class AddMoreColumnTypesToWands < ActiveRecord::Migration
     add_column :wands, :hardness,       :decimal, null: false, precision: 10, scale: 10, default: 5
     add_column :wands, :reflectance,    :decimal, null: false, precision: 10, scale: 0, default: 0.5
     add_column :wands, :broken,         :boolean, null: false, default: false
+    add_column :wands, :broken_at,      :datetime, null: true
     add_column :wands, :chosen_at_date, :date
     add_column :wands, :chosen_at_time, :time
     # JSON column type is only supported on 5.2 or higher

data/spec/support/v4.2/db/schema.rb

@@ -30,6 +30,7 @@ ActiveRecord::Schema.define(version: 20190620000007) do
     t.decimal  "hardness",       precision: 10, scale: 10, default: 5.0,   null: false
     t.decimal  "reflectance",    precision: 10,            default: 0,     null: false
     t.boolean  "broken",                                   default: false, null: false
+    t.datetime "broken_at"
     t.date     "chosen_at_date"
     t.time     "chosen_at_time"
   end
@@ -39,8 +40,8 @@ ActiveRecord::Schema.define(version: 20190620000007) do
     t.integer  "house"
     t.string   "parent_email"
     t.text     "notes"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at",                      null: false
+    t.datetime "updated_at",                      null: false
     t.string   "broom"
     t.string   "type",         default: "Wizard", null: false
   end

data/spec/support/v4.2/sorbet_test_cases.rb

@@ -1,12 +1,29 @@
 # typed: false
 require 'sorbet-runtime'
 
+wand = Wand.first!
 wizard = Wizard.first!
 T.assert_type!(wizard, Wizard)
 
 # -- model columns
 T.assert_type!(wizard.name, T.nilable(String))
 
+# -- time/date columns
+T.assert_type!(wizard.created_at, ActiveSupport::TimeWithZone)
+T.assert_type!(wand.broken_at, T.nilable(Time))
+T.assert_type!(wand.chosen_at_date, T.nilable(Date))
+
+# assert that TZ aware attributes are casted to TimeWithZone after assigning
+wizard.created_at = DateTime.now
+T.assert_type!(wizard.created_at, ActiveSupport::TimeWithZone)
+
+if ENV["RAILS_VERSION"] != "4.2"
+  # note: this is expected to fail in Rails 4.2, because in that version only
+  # `datetime` fields are made time zone aware (so this will have the type
+  # `T.nilable(Time)` instead)
+  T.assert_type!(wand.chosen_at_time, T.nilable(ActiveSupport::TimeWithZone))
+end
+
 # -- model associations
 T.assert_type!(wizard.wand, T.nilable(Wand))
 T.assert_type!(T.must(wizard.wand).wizard, Wizard)

data/spec/support/v5.0/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.5.5)
+    sorbet-rails (0.5.6)
       parlour (~> 0.8.0)
 
 GEM
@@ -100,10 +100,10 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    sorbet (0.4.4755)
-      sorbet-static (= 0.4.4755)
-    sorbet-runtime (0.4.4755)
-    sorbet-static (0.4.4755-universal-darwin-14)
+    sorbet (0.4.4761)
+      sorbet-static (= 0.4.4761)
+    sorbet-runtime (0.4.4761)
+    sorbet-static (0.4.4761-universal-darwin-14)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/spec/support/v5.0/app/models/wand.rb

@@ -2,6 +2,8 @@
 class Wand < ApplicationRecord
   include Mythical
 
+  self.skip_time_zone_conversion_for_attributes = [:broken_at]
+
   enum core_type: {
     phoenix_feather: 0,
     dragon_heartstring: 1,