sorbet-rails 0.6.5.1 → 0.7.4

data/lib/sorbet-rails/tasks/rails_rbi.rake

@@ -35,19 +35,19 @@ namespace :rails_rbi do
     File.write(file_path, inspector.format(SorbetRails::RoutesRbiFormatter.new))
   end
 
-  desc "Copy custom rbis for ActionController::Parameters, pluck_to_struct, etc."
+  desc "Copy custom rbis for typed_params, pluck_to_struct, etc."
   task custom: :environment do
     copy_bundled_rbi('type_assert.rbi')
-    copy_bundled_rbi('parameters.rbi')
     copy_bundled_rbi('pluck_to_tstruct.rbi')
     copy_bundled_rbi('typed_params.rbi')
+    copy_bundled_rbi('typed_enum.rbi')
 
     # These files were previously bundled_rbi but are now generated so this
     # is needed for backwards compatibility with anyone using `rails_rbi:custom`
     Rake::Task['rails_rbi:active_record'].invoke
   end
 
-  desc "Generate rbis for rails mailers"
+  desc "Generate rbis for rails active_record base"
   task :active_record, [:root_dir] => :environment do |t, args|
     formatter = SorbetRails::ActiveRecordRbiFormatter.new
     FileUtils.mkdir_p(Rails.root.join("sorbet", "rails-rbi"))
@@ -97,17 +97,18 @@ namespace :rails_rbi do
   task helpers: :environment do |t, args|
     SorbetRails::Utils.rails_eager_load_all!
 
-    if ApplicationController.methods.include?(:modules_for_helpers)
+    # API controller does not include ActionController::Helpers
+    if ApplicationController < ActionController::Helpers
       helpers = ApplicationController.modules_for_helpers([:all])
     end
 
     # If ApplicationController doesn't work or doesn't return any helpers,
     # try using ActionController::Base.
-    if ActionController::Base.methods.include?(:modules_for_helpers) && (helpers.nil? || helpers.length == 0)
+    if ApplicationController < ActionController::Helpers && helpers.blank?
       helpers = ActionController::Base.modules_for_helpers([:all])
     end
 
-    if helpers.nil? || helpers.length == 0
+    if helpers.blank?
       puts 'No helpers found.'
     else
       formatter = SorbetRails::HelperRbiFormatter.new(helpers)
@@ -129,7 +130,7 @@ namespace :rails_rbi do
         "mailers",
         "#{mailer_class.name.underscore}.rbi",
       )
-      formatter = SorbetRails::MailerRbiFormatter.new(mailer_class)
+      formatter = ::SorbetRails.config.mailer_generator_class.new(mailer_class)
       FileUtils.mkdir_p(File.dirname(file_path))
       File.write(file_path, formatter.generate_rbi)
     end
@@ -147,7 +148,7 @@ namespace :rails_rbi do
         "jobs",
         "#{job_class.name.underscore}.rbi",
       )
-      formatter = SorbetRails::JobRbiFormatter.new(job_class)
+      formatter = ::SorbetRails.config.job_generator_class.new(job_class)
       FileUtils.mkdir_p(File.dirname(file_path))
       File.write(file_path, formatter.generate_rbi)
     end

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.6.5.1"
+  s.version       = "0.7.4"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  s.add_dependency 'parlour', '~> 2.0'
+  s.add_dependency 'parlour', '>= 4.0.1'
   s.add_dependency 'sorbet-runtime', '>= 0.5'
   s.add_dependency 'sorbet-coerce', '>= 0.2.6'
   s.add_dependency 'method_source', '>= 0.9.2'

data/spec/bin/run_spec.sh

@@ -30,5 +30,5 @@ if [[ -z $RAILS_VERSION ]]; then
 else
   echo "---- Run $RAILS_VERSION ----"
   RAILS_VERSION=$RAILS_VERSION bundle update
-  RAILS_VERSION=$RAILS_VERSION DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle exec rake
+  RAILS_VERSION=$RAILS_VERSION DISABLE_DATABASE_ENVIRONMENT_CHECK=1 SBR_DEBUG_MODE=true bundle exec rake
 fi

data/spec/generators/rails-template.rb

@@ -180,6 +180,11 @@ def create_models
         blue: 2,
       }, _prefix: :color, _suffix: :eyes
 
+      serialize :owl_results, Hash
+      serialize :newt_subjects # no specific data type, uses the default YAML Object coder
+      serialize :pets, Array
+      serialize :patronus_characteristics, JSON
+
       has_one :wand
       has_many :spell_books
       # habtm which is optional at the db level
@@ -417,6 +422,17 @@ def create_migrations
     end
   RUBY
 
+  file "db/migrate/20190620000015_add_serialized_to_wizards.rb", <<~RUBY
+    class AddSerializedToWizards < #{migration_superclass}
+      def change
+        add_column :wizards, :owl_results, :text # Hash
+        add_column :wizards, :newt_subjects, :text # generic
+        add_column :wizards, :pets, :text # Array
+        add_column :wizards, :patronus_characteristics, :text # serialized as JSON, but not a JSON column type
+      end
+    end
+  RUBY
+
 end
 
 def create_mailers

data/spec/generators/sorbet_test_cases.rb

@@ -305,6 +305,21 @@ T.assert_type!(Wizard::House::Hufflepuff, Wizard::House)
 T.assert_type!(Wizard::House::Ravenclaw, Wizard::House)
 T.assert_type!(Wizard::House::Slytherin, Wizard::House)
 
+# Serialization
+T.assert_type!(
+  wizard.owl_results,
+  T.nilable(T::Hash[T.untyped, T.untyped])
+)
+T.assert_type!(
+  wizard.newt_subjects,
+  T.nilable(T.any(T::Array[T.untyped], T::Boolean, Float, T::Hash[T.untyped, T.untyped], Integer, String))
+)
+T.assert_type!(
+  wizard.patronus_characteristics,
+  T.nilable(T.any(T::Array[T.untyped], T::Boolean, Float, T::Hash[String, T.untyped], Integer, String))
+)
+T.assert_type!(wizard.pets, T.nilable(T::Array[T.untyped]))
+
 # Mythical plugin
 T.assert_type!(Wand.mythicals, T::Array[Wand])
 
@@ -312,7 +327,10 @@ T.assert_type!(Wand.mythicals, T::Array[Wand])
 T.assert_type!(HogwartsAcceptanceMailer.notify(wizard), ActionMailer::MessageDelivery)
 
 # Jobs
-AwardHousePointHourglasses.perform_later(student: wizard, point: 10)
+T.assert_type!(
+  AwardHousePointHourglasses.perform_later(student: wizard, point: 10),
+  AwardHousePointHourglasses
+)
 AwardHousePointHourglasses.perform_now(student: wizard, point: 10)
 AwardHousePointHourglasses.
   set(queue: :daily, wait: 5.minutes).
@@ -321,7 +339,6 @@ AwardHousePointHourglasses.
   set(priority: 10, wait_until: Time.now.tomorrow).
   perform_later(student: wizard, point: 10)
 
-
 T.assert_type!(wizard.broom_nimbus?, T::Boolean)
 T.assert_type!(wizard.color_brown_eyes?, T::Boolean)
 T.assert_type!(wizard.quidditch_keeper?, T::Boolean)
@@ -361,44 +378,6 @@ params = ActionController::Parameters.new({
 typed_params = TypedParams[MyActionParams].new.extract!(params)
 T.assert_type!(typed_params, MyActionParams)
 
-# -- require_typed
-T.assert_type!(
-  params.require_typed(:age, TA[Integer].new),
-  Integer,
-)
-T.assert_type!(
-  params.require_typed(:name, TA[String].new),
-  String,
-)
-info = params.require_typed(:info, TA[ActionController::Parameters].new)
-T.assert_type!(info, ActionController::Parameters)
-T.assert_type!(
-  info.require_typed(:friends, TA[T::Array[String]].new),
-  T::Array[String],
-)
-# -- fetch_typed
-T.assert_type!(
-  params.fetch_typed(:age, TA[Integer].new),
-  Integer,
-)
-T.assert_type!(
-  params.fetch_typed(:name, TA[String].new),
-  String,
-)
-T.assert_type!(
-  params.fetch_typed(:nonexistence, TA[String].new, ''),
-  String,
-)
-T.assert_type!(
-  params.fetch_typed(:nonexistence, TA[T.nilable(String)].new, nil),
-  T.nilable(String),
-)
-T.assert_type!(
-  params.fetch_typed(:nonexistence, TA[T::Array[Integer]].new, []),
-  T::Array[Integer],
-)
-
-
 # -- pluck to tstruct
 class WizardStruct < T::Struct
   const :name, String
@@ -415,23 +394,16 @@ Wizard.all.pluck_to_tstruct(TA[WizardStruct].new).each do |row|
   T.assert_type!(row, WizardStruct)
 end
 
-
 # -- GeneratedUrlHelpers
 class TestHelper
   include GeneratedUrlHelpers
-
-  # need to implement this for the url
-  def default_url_options
-    {
-      protocol: 'http',
-      host: 'localhost',
-      port: 3000,
-    }
-  end
-
-  def test_url_helper
-    T.assert_type!(test_index_path, String)
-    T.assert_type!(test_index_url, String)
-  end
 end
-TestHelper.new.test_url_helper
+
+T.assert_type!(TestHelper.new.test_index_path, String)
+# need to set this config for _url methods
+Rails.application.routes.default_url_options = {
+  protocol: 'http',
+  host: 'localhost',
+  port: 3000,
+}
+T.assert_type!(TestHelper.new.test_index_url, String)

data/spec/job_rbi_formatter_spec.rb

@@ -1,5 +1,5 @@
 require 'rails_helper'
-require 'sorbet-rails/mailer_rbi_formatter'
+require 'sorbet-rails/job_rbi_formatter'
 
 RSpec.describe SorbetRails::MailerRbiFormatter do
 

data/spec/pluck_to_tstruct_spec.rb

@@ -1,5 +1,6 @@
 require 'rails_helper'
 require 'sorbet-rails/model_rbi_formatter'
+require 'tstruct_comparable'
 
 RSpec.describe SorbetRails::PluckToTStruct do
   let!(:harry) do
@@ -9,6 +10,18 @@ RSpec.describe SorbetRails::PluckToTStruct do
     )
   end
 
+  let!(:harrys_wand) do
+    Wand.create!(
+      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
+
   let!(:hermione) do
     Wizard.create!(
       name: 'Hermione Granger',
@@ -16,31 +29,53 @@ RSpec.describe SorbetRails::PluckToTStruct do
     )
   end
 
+  let!(:hermiones_wand) do
+    Wand.create!(
+      wizard: hermione,
+      core_type: :phoenix_feather,
+      wood_type: "Vine",
+      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
+
   class WizardName < T::Struct
+    include TStructComparable
+
     const :name, String
+  end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      name == other.name
-    end
+  class WizardT < T::Struct
+    include TStructComparable
 
-    def eql?(other)
-      self == other
-    end
+    const :name, String
+    const :house, String
   end
 
-  class WizardT < T::Struct
+  class WizardWithWandT < T::Struct
+    include TStructComparable
+
     const :name, String
     const :house, String
+    const :wand_wood_type, String
+  end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      name == other.name && house == other.house
-    end
+  class WizardWithDefaultParentEmailT < T::Struct
+    include TStructComparable
 
-    def eql?(other)
-      self == other
-    end
+    const :name, String
+    const :house, String
+    const :parent_email, String, default: "hagrid@hogwarts.com"
+  end
+
+  class WizardWithDefaultNilableParentEmailT < T::Struct
+    include TStructComparable
+
+    const :name, String
+    const :house, String
+    const :parent_email, T.nilable(String), default: "hagrid@hogwarts.com"
   end
 
   shared_examples 'pluck_to_tstruct' do |struct_type, expected_values|
@@ -55,6 +90,18 @@ RSpec.describe SorbetRails::PluckToTStruct do
     end
   end
 
+  shared_examples 'pluck_to_tstruct with associations' do |struct_type, associations, expected_values|
+    it 'plucks correctly from ActiveRecord model with associations' do
+      plucked = Wizard.joins(:wand).pluck_to_tstruct(TA[struct_type].new, associations: associations)
+      expect(plucked).to match_array(expected_values)
+    end
+
+    it 'plucks correctly from ActiveRecord relation with associations' do
+      plucked = Wizard.all.joins(:wand).pluck_to_tstruct(TA[struct_type].new, associations: associations)
+      expect(plucked).to match_array(expected_values)
+    end
+  end
+
   context 'pluck 1 attribute' do
     it_should_behave_like 'pluck_to_tstruct', WizardName, [
       WizardName.new(name: "Harry Potter"),
@@ -72,8 +119,60 @@ RSpec.describe SorbetRails::PluckToTStruct do
   context 'given a wrong type' do
     it 'should raise error' do
       expect {
-        plucked = Wizard.pluck_to_tstruct(TA[String].new)
+        Wizard.pluck_to_tstruct(TA[String].new)
       }.to raise_error(SorbetRails::PluckToTStruct::UnexpectedType)
     end
   end
+
+  context "given associations mappings that don't exist in T::Struct" do
+    it 'should raise error' do
+      expect {
+        Wizard.pluck_to_tstruct(
+          TA[WizardWithWandT].new,
+          associations: { wood_type: "wands.wood_type" }
+        )
+      }.to raise_error(SorbetRails::PluckToTStruct::UnexpectedAssociations)
+    end
+  end
+
+  context 'pluck with associations' do
+    associations = { wand_wood_type: "wands.wood_type" }
+
+    expected = [
+      WizardWithWandT.new(name: "Harry Potter", house: "Gryffindor", wand_wood_type: "Holly"),
+      WizardWithWandT.new(name: "Hermione Granger", house: "Gryffindor", wand_wood_type: "Vine"),
+    ]
+
+    it_should_behave_like 'pluck_to_tstruct with associations', WizardWithWandT, associations, expected
+  end
+
+  context 'uses default value if prop type is not nilable and has default value' do
+    it_should_behave_like 'pluck_to_tstruct', WizardWithDefaultParentEmailT, [
+      WizardWithDefaultParentEmailT.new(
+        name: "Harry Potter",
+        house: "Gryffindor",
+        parent_email: "hagrid@hogwarts.com"
+      ),
+      WizardWithDefaultParentEmailT.new(
+        name: "Hermione Granger",
+        house: "Gryffindor",
+        parent_email: "hagrid@hogwarts.com"
+      ),
+    ]
+  end
+
+  context 'doesnt use default value if prop type is nilable even with a default value' do
+    it_should_behave_like 'pluck_to_tstruct', WizardWithDefaultNilableParentEmailT, [
+      WizardWithDefaultNilableParentEmailT.new(
+        name: "Harry Potter",
+        house: "Gryffindor",
+        parent_email: nil
+      ),
+      WizardWithDefaultNilableParentEmailT.new(
+        name: "Hermione Granger",
+        house: "Gryffindor",
+        parent_email: nil
+      ),
+    ]
+  end
 end

data/spec/rails_helper.rb

@@ -36,7 +36,6 @@ RSpec.configure do |config|
     next if ENV["DISABLE_DATABASE_CLEANER"] == 'true'
     DatabaseCleaner.clean_with(:truncation, {
       pre_count: true,
-      reset_ids: false,
       except: %w(ar_internal_metadata),
     })
   end
@@ -46,10 +45,7 @@ RSpec.configure do |config|
       example.run
       next
     end
-    DatabaseCleaner.strategy = :truncation, {
-      pre_count: true,
-      reset_ids: false,
-    }
+    DatabaseCleaner.strategy = :truncation, { pre_count: true }
     DatabaseCleaner.start
     example.run
     DatabaseCleaner.clean
@@ -70,7 +66,7 @@ end
 # File uses File::SEPARATOR by default but will also use File::ALT_SEPARATOR if it's not nil
 FILE_SEPARATOR_RE = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact).freeze
 
-def expect_files(base_dir:, files:)
+def expect_files(base_dir:, files:, expected_file_prefix: "expected")
   dirs = Set.new([base_dir])
   # if any files contain file separators then include those paths in our globbing as well
   files.each do |f|
@@ -92,7 +88,7 @@ def expect_files(base_dir:, files:)
     generated = File.read(file_path)
     # expect there is the same file in test_data folder
     path_from_dir = pathname.relative_path_from(base_dir).to_path
-    expect_match_file(generated, "expected_#{path_from_dir}")
+    expect_match_file(generated, "#{expected_file_prefix}_#{path_from_dir}")
     path_from_dir
   end