sorbet-rails 0.5.6 → 0.5.7

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

@@ -24,7 +24,7 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
     # rails/activerecord/lib/active_record/querying.rb
     model_query_relation_methods = [
       :select, :reselect, :order, :reorder, :group, :limit, :offset, :joins, :left_joins, :left_outer_joins,
-      :where, :rewhere, :preload, :extract_associated, :eager_load, :includes, :from, :lock, :readonly, :extending, :or,
+      :where, :rewhere, :preload, :extract_associated, :eager_load, :includes, :from, :lock, :readonly, :or,
       :having, :create_with, :distinct, :references, :none, :unscope, :optimizer_hints, :merge, :except, :only,
     ]
     model_query_relation_methods.each do |method_name|
@@ -33,9 +33,17 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
         method_name.to_s,
         parameters: [
           Parameter.new("*args", type: "T.untyped"),
-          Parameter.new("&block", type: "T.nilable(T.proc.void)"),
         ],
       ) if exists_class_method?(method_name)
     end
+
+    add_relation_query_method(
+      root,
+      "extending",
+      parameters: [
+        Parameter.new("*args", type: "T.untyped"),
+        Parameter.new("&block", type: "T.nilable(T.proc.void)"),
+      ]
+    )
   end
 end

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

@@ -72,6 +72,12 @@ module SorbetRails::ModelPlugins
     when :friendly_id
       require('sorbet-rails/gem_plugins/friendly_id_plugin')
       FriendlyIdPlugin
+    when :shrine
+      require('sorbet-rails/gem_plugins/shrine_plugin')
+      ShrinePlugin
+    when :elastic_search
+      require('sorbet-rails/gem_plugins/elastic_search_plugin')
+      ElasticSearchPlugin
     else
       raise UnrecognizedPluginName.new(
         "Unrecognized plugin with name: #{plugin_name}. Please check available plugins in the

data/lib/sorbet-rails/rails_mixins/pluck_to_tstruct.rb

@@ -0,0 +1,33 @@
+# typed: false
+require 'sorbet-runtime'
+
+module SorbetRails::PluckToTStruct
+  extend T::Sig
+  sig {
+    type_parameters(:U).
+    params(
+      ta_struct: ITypeAssert[T.type_parameter(:U)],
+    ).
+    returns(T::Array[T.type_parameter(:U)])
+  }
+  def pluck_to_tstruct(ta_struct)
+    tstruct = ta_struct.get_type
+  
+    if !(tstruct < T::Struct)
+      raise UnexpectedType.new("pluck_to_tstruct expects a tstruct subclass, given #{tstruct}")
+    end
+
+    keys = tstruct.props.keys
+
+    # loosely based on pluck_to_hash gem
+    # https://github.com/girishso/pluck_to_hash/blob/master/lib/pluck_to_hash.rb
+    keys_one = keys.size == 1
+    pluck(*keys).map do |row|
+      row = [row] if keys_one
+      value = Hash[keys.zip(row)]
+      tstruct.new(value)
+    end
+  end
+  
+  class UnexpectedType < StandardError; end
+end

data/lib/sorbet-rails/railtie.rb

@@ -15,10 +15,14 @@ class SorbetRails::Railtie < Rails::Railtie
     ActiveSupport.on_load(:active_record) do
       require "sorbet-rails/rails_mixins/active_record_overrides"
       require "sorbet-rails/rails_mixins/custom_finder_methods"
+      require "sorbet-rails/rails_mixins/pluck_to_tstruct"
 
       ActiveRecord::Base.extend SorbetRails::CustomFinderMethods
       ActiveRecord::Relation.include SorbetRails::CustomFinderMethods
 
+      ActiveRecord::Base.extend SorbetRails::PluckToTStruct
+      ActiveRecord::Relation.include SorbetRails::PluckToTStruct
+
       class ::ActiveRecord::Base
         # open ActiveRecord::Base to override inherited
         class << self

data/lib/sorbet-rails/sorbet_utils.rb

@@ -11,7 +11,10 @@ module SorbetRails::SorbetUtils
     signature = T::Private::Methods.signature_for_method(method_def)
 
     parameters_with_type = signature.nil? ?
-      method_def.parameters.map { |p| p + ['T.untyped'] } : # append untyped to each
+      method_def.parameters.map { |p|
+        p1 = p.size == 1 ? p + ['_'] : p # give param without name default name _
+        p1 + ['T.untyped'] # append untyped as type of each param
+      } :
       get_ordered_parameters_with_type(signature)
 
     parameters_with_type.map do |param_def|

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

@@ -18,7 +18,7 @@ namespace :rails_rbi do
     Rake::Task['rails_rbi:models'].invoke
     Rake::Task['rails_rbi:helpers'].invoke
     Rake::Task['rails_rbi:mailers'].invoke
-    Rake::Task['rails_rbi:params'].invoke
+    Rake::Task['rails_rbi:custom'].invoke
   end
 
   desc "Generate rbis for rails routes"
@@ -32,9 +32,11 @@ namespace :rails_rbi do
     File.write(file_path, inspector.format(SorbetRails::RoutesRbiFormatter.new))
   end
 
-  desc "Copy additional rbis for ActionController::Parameters"
-  task params: :environment do
+  desc "Copy custom rbis for ActionController::Parameters, 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')
   end
 
   desc "Generate rbis for rails models. Pass models name to regenerate rbi for only the given models."
@@ -43,9 +45,17 @@ namespace :rails_rbi do
 
     all_models = Set.new(ActiveRecord::Base.descendants + whitelisted_models - blacklisted_models)
 
-    models_to_generate = args.extras.size > 0 ?
-      args.extras.map { |m| Object.const_get(m) } :
-      all_models
+    models_to_generate = all_models
+    if args.extras.size > 0
+      models_to_generate = args.extras.map { |m| Object.const_get(m) }
+      # also generate descendants of a model
+      models_to_generate = models_to_generate.
+        map { |m| [m, m.descendants] }.
+        flatten.
+        uniq
+      # be safe about ignoring blacklisted models
+      models_to_generate = models_to_generate - blacklisted_models
+    end
 
     generated_rbis = generate_rbis_for_models(models_to_generate, all_models)
     generated_rbis.each do |model_name, contents|

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.5.6"
+  s.version       = "0.5.7"
   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/bin/run_all_specs.sh

@@ -3,7 +3,6 @@
 
 wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-RAILS_VERSION=4.2 bash $wd/run_spec.sh
 RAILS_VERSION=5.0 bash $wd/run_spec.sh
 RAILS_VERSION=5.1 bash $wd/run_spec.sh
 RAILS_VERSION=6.0 bash $wd/run_spec.sh

data/spec/bin/run_spec.sh

@@ -11,17 +11,15 @@ else
   rails_dir="$wd/../support/v$RAILS_VERSION"
 fi
 
-bundle_version=$([ "$RAILS_VERSION" == 4.2 ] && echo "_1.17.3_" || echo "")
-
 # clean up & install gems
 rm $wd/../../Gemfile.lock 2>/dev/null # clean up Gemfile.lock first
-bundle $bundle_version install
+bundle install
 
 echo $rails_dir
 
 # update gems in rails_dir
 cd $rails_dir
-bundle $bundle_version install
+bundle install
 
 # move back to current dir to run test
 cd $current_dir
@@ -31,6 +29,6 @@ if [[ -z $RAILS_VERSION ]]; then
   bundle update && DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle exec rake
 else
   echo "---- Run $RAILS_VERSION ----"
-  RAILS_VERSION=$RAILS_VERSION bundle $bundle_version update
-  RAILS_VERSION=$RAILS_VERSION DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle $bundle_version exec rake
+  RAILS_VERSION=$RAILS_VERSION bundle update
+  RAILS_VERSION=$RAILS_VERSION DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle exec rake
 fi

data/spec/generators/rails-template.rb

@@ -76,14 +76,6 @@ def create_helpers
 end
 
 def create_models
-  if ENV['RAILS_VERSION'] == '4.2'
-    file "app/models/application_record.rb", <<~RUBY
-      class ApplicationRecord < ActiveRecord::Base
-        self.abstract_class = true
-      end
-    RUBY
-  end
-
   file "app/models/spell_book.rb", <<~RUBY
     class SpellBook < ApplicationRecord
       validates :name, length: { minimum: 5 }, presence: true
@@ -131,89 +123,56 @@ def create_models
     attachments = "has_one_attached :school_photo\n  has_many_attached :hats"
   end
 
-  if ENV["RAILS_VERSION"] == "4.2"
-    file "app/models/wizard.rb", <<~RUBY
-      class Wizard < ApplicationRecord
-        validates :name, length: { minimum: 5 }, presence: true
-
-        enum house: {
-          Gryffindor: 0,
-          Hufflepuff: 1,
-          Ravenclaw: 2,
-          Slytherin: 3,
-        }
-
-        enum professor: {
-          "Severus Snape": 0,
-          "Minerva McGonagall": 1,
-          "Pomona Sprout": 2,
-          "Filius Flitwick": 3,
-          "Hagrid": 4,
-        }
-
-        enum broom: {
-          nimbus: 'nimbus',
-          firebolt: 'firebolt',
-        }
-
-        has_one :wand
-        has_many :spell_books
-
-        scope :recent, -> { where('created_at > ?', 1.month.ago) }
-      end
-    RUBY
-  else
-    file "app/models/wizard.rb", <<~RUBY
-      class Wizard < ApplicationRecord
-        validates :name, length: { minimum: 5 }, presence: true
-
-        enum house: {
-          Gryffindor: 0,
-          Hufflepuff: 1,
-          Ravenclaw: 2,
-          Slytherin: 3,
-        }
-
-        enum professor: {
-          "Severus Snape": 0,
-          "Minerva McGonagall": 1,
-          "Pomona Sprout": 2,
-          "Filius Flitwick": 3,
-          "Hagrid": 4,
-        }
-
-        enum broom: {
-          nimbus: 'nimbus',
-          firebolt: 'firebolt',
-        }, _prefix: true
-
-        enum quidditch_position: {
-          keeper: 0,
-          seeker: 1,
-          beater: 2,
-          chaser: 3,
-        }, _prefix: :quidditch
-
-        enum hair_color: {
-          brown: 0,
-          black: 1,
-          blonde: 2,
-        }, _suffix: :hair
-
-        enum eye_color: {
-          brown: 0,
-          green: 1,
-          blue: 2,
-        }, _prefix: :color, _suffix: :eyes
-
-        has_one :wand
-        has_many :spell_books
-
-        scope :recent, -> { where('created_at > ?', 1.month.ago) }
-        #{attachments}
-      end
-    RUBY
-  end
+  file "app/models/wizard.rb", <<~RUBY
+    class Wizard < ApplicationRecord
+      validates :name, length: { minimum: 5 }, presence: true
+
+      enum house: {
+        Gryffindor: 0,
+        Hufflepuff: 1,
+        Ravenclaw: 2,
+        Slytherin: 3,
+      }
+
+      enum professor: {
+        "Severus Snape": 0,
+        "Minerva McGonagall": 1,
+        "Pomona Sprout": 2,
+        "Filius Flitwick": 3,
+        "Hagrid": 4,
+      }
+
+      enum broom: {
+        nimbus: 'nimbus',
+        firebolt: 'firebolt',
+      }, _prefix: true
+
+      enum quidditch_position: {
+        keeper: 0,
+        seeker: 1,
+        beater: 2,
+        chaser: 3,
+      }, _prefix: :quidditch
+
+      enum hair_color: {
+        brown: 0,
+        black: 1,
+        blonde: 2,
+      }, _suffix: :hair
+
+      enum eye_color: {
+        brown: 0,
+        green: 1,
+        blue: 2,
+      }, _prefix: :color, _suffix: :eyes
+
+      has_one :wand
+      has_many :spell_books
+
+      scope :recent, -> { where('created_at > ?', 1.month.ago) }
+      #{attachments}
+    end
+  RUBY
 
   file "app/models/concerns/mythical.rb", <<~RUBY
     require 'active_support/concern'
@@ -238,11 +197,7 @@ def create_models
 end
 
 def create_migrations
-  if ENV["RAILS_VERSION"] == "4.2"
-    migration_superclass = 'ActiveRecord::Migration'
-  else
-    migration_superclass = "ActiveRecord::Migration[#{ENV['RAILS_VERSION']}]"
-  end
+  migration_superclass = "ActiveRecord::Migration[#{ENV['RAILS_VERSION']}]"
 
   file "db/migrate/20190620000001_create_wizards.rb", <<~RUBY
     class CreateWizards < #{migration_superclass}
@@ -296,7 +251,7 @@ def create_migrations
         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
-        unless ['4.2', '5.0', '5.1'].include?(ENV['RAILS_VERSION'])
+        unless ['5.0', '5.1'].include?(ENV['RAILS_VERSION'])
           add_column :wands, :spell_history,  :json
           add_column :wands, :maker_info,     :json,    null: false, default: '{}'
         end
@@ -312,18 +267,16 @@ def create_migrations
     end
   RUBY
 
-  if ENV["RAILS_VERSION"] != "4.2"
-    file "db/migrate/20190620000006_add_more_enums_to_wizard.rb", <<~RUBY
-      class AddMoreEnumsToWizard < #{migration_superclass}
-        def change
-          add_column :wizards, :quidditch_position, :integer
-          add_column :wizards, :hair_color, :integer
-          add_column :wizards, :eye_color, :integer
-          add_column :wizards, :hair_length, :integer
-        end
+  file "db/migrate/20190620000006_add_more_enums_to_wizard.rb", <<~RUBY
+    class AddMoreEnumsToWizard < #{migration_superclass}
+      def change
+        add_column :wizards, :quidditch_position, :integer
+        add_column :wizards, :hair_color, :integer
+        add_column :wizards, :eye_color, :integer
+        add_column :wizards, :hair_length, :integer
       end
-    RUBY
-  end
+    end
+  RUBY
 
   file "db/migrate/20190620000007_add_type_to_wizard.rb", <<~RUBY
     class AddTypeToWizard < #{migration_superclass}
@@ -335,13 +288,6 @@ def create_migrations
 end
 
 def create_mailers
-  if ENV['RAILS_VERSION'] == '4.2'
-    file "app/mailers/application_mailer.rb", <<~RUBY
-      class ApplicationMailer < ActionMailer::Base
-      end
-    RUBY
-  end
-
   file "app/mailers/hogwarts_acceptance_mailer.rb", <<~RUBY
     class HogwartsAcceptanceMailer < ApplicationMailer
       extend T::Sig
@@ -386,7 +332,7 @@ end
 # Main setup
 source_paths
 
-if ['4.2', '5.0'].include?(ENV["RAILS_VERSION"])
+if ['5.0'].include?(ENV["RAILS_VERSION"])
   File.open('Gemfile', 'r+') do |f|
     out = ""
     f.each do |line|
@@ -414,19 +360,16 @@ after_bundle do
   create_mailers
   add_sorbet_test_files
 
-  bundle_version = ENV["RAILS_VERSION"] == "4.2" ? "_1.17.3_" : ""
-
   Bundler.with_clean_env do
-    # Rails 4.2 doesn't have the rails_command method, so just use run.
-    run "bundle #{bundle_version} exec rake db:migrate"
+    run "bundle exec rake db:migrate"
   end
 
   if ENV["RUN_WITH_SORBET"] != 'false'
     Bundler.with_clean_env do
-      run "SRB_YES=true bundle #{bundle_version} exec srb init"
-      run "bundle #{bundle_version} exec rake rails_rbi:all"
-      run "bundle #{bundle_version} exec srb rbi hidden-definitions"
-      run "bundle #{bundle_version} exec srb rbi todo"
+      run "SRB_YES=true bundle exec srb init"
+      run "bundle exec rake rails_rbi:all"
+      run "bundle exec srb rbi hidden-definitions"
+      run "bundle exec srb rbi todo"
     end
   end
   say "Done!"

data/spec/generators/sorbet_test_cases.rb

@@ -17,12 +17,7 @@ T.assert_type!(wand.chosen_at_date, T.nilable(Date))
 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
+T.assert_type!(wand.chosen_at_time, T.nilable(ActiveSupport::TimeWithZone))
 
 # -- model associations
 T.assert_type!(wizard.wand, T.nilable(Wand))
@@ -87,9 +82,9 @@ spell_books = wizard.spell_books
 T.assert_type!(spell_books.exists?(name: 'Fantastic Beasts'), T::Boolean)
 T.assert_type!(spell_books.find(spell_book.id), SpellBook)
 T.assert_type!(spell_books.first!, SpellBook)
-# T.assert_type!(spell_books.first, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+# T.assert_type!(spell_books.first, T.nilable(SpellBook)) # TODO fix sig for 5.0
 T.assert_type!(spell_books.last!, SpellBook)
-# T.assert_type!(spell_books.last, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+# T.assert_type!(spell_books.last, T.nilable(SpellBook)) # TODO fix sig for 5.0
 T.assert_type!(spell_books.first_n(5), T::Array[SpellBook])
 T.assert_type!(spell_books.last_n(5), T::Array[SpellBook])
 T.assert_type!(spell_books.find_by(name: 'Fantastic Beasts'), T.nilable(SpellBook))
@@ -109,9 +104,9 @@ spell_books_query = spell_books.where(id: 1)
 T.assert_type!(spell_books_query.exists?(name: 'Fantastic Beasts'), T::Boolean)
 T.assert_type!(spell_books_query.find(spell_book.id), SpellBook)
 T.assert_type!(spell_books_query.first!, SpellBook)
-# T.assert_type!(spell_books_query.first, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+# T.assert_type!(spell_books_query.first, T.nilable(SpellBook)) # TODO fix sig for 5.0
 T.assert_type!(spell_books_query.last!, SpellBook)
-# T.assert_type!(spell_books_query.last, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+# T.assert_type!(spell_books_query.last, T.nilable(SpellBook)) # TODO fix sig for 5.0
 T.assert_type!(spell_books_query.first_n(5), T::Array[SpellBook])
 T.assert_type!(spell_books_query.last_n(5), T::Array[SpellBook])
 T.assert_type!(spell_books_query.find_by(name: 'Fantastic Beasts'), T.nilable(SpellBook))
@@ -180,12 +175,10 @@ T.assert_type!(Wand.mythicals, T::Array[Wand])
 
 T.assert_type!(HogwartsAcceptanceMailer.notify(wizard), ActionMailer::MessageDelivery)
 
-if ENV["RAILS_VERSION"] != "4.2"
-  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)
-  T.assert_type!(wizard.brown_hair?, T::Boolean)
-end
+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)
+T.assert_type!(wizard.brown_hair?, T::Boolean)
 
 # -- Custom ActionController::Parameters Methods
 params = ActionController::Parameters.new({
@@ -236,3 +229,20 @@ 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
+  const :house, T.nilable(String)
+end
+
+T.assert_type!(Wizard.pluck_to_tstruct(TA[WizardStruct].new), T::Array[WizardStruct])
+T.assert_type!(Wizard.all.pluck_to_tstruct(TA[WizardStruct].new), T::Array[WizardStruct])
+
+Wizard.pluck_to_tstruct(TA[WizardStruct].new).each do |row|
+  T.assert_type!(row, WizardStruct)
+end
+Wizard.all.pluck_to_tstruct(TA[WizardStruct].new).each do |row|
+  T.assert_type!(row, WizardStruct)
+end