sorbet-rails 0.5.6 → 0.5.7

data/spec/pluck_to_tstruct_spec.rb

@@ -0,0 +1,79 @@
+require 'rails_helper'
+require 'sorbet-rails/model_rbi_formatter'
+
+RSpec.describe SorbetRails::PluckToTStruct do
+  let!(:harry) do
+    Wizard.create!(
+      name: 'Harry Potter',
+      house: :Gryffindor,
+    )
+  end
+
+  let!(:hermione) do
+    Wizard.create!(
+      name: 'Hermione Granger',
+      house: :Gryffindor,
+    )
+  end
+
+  class WizardName < T::Struct
+    const :name, String
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      name == other.name
+    end
+
+    def eql?(other)
+      self == other
+    end
+  end
+
+  class WizardT < T::Struct
+    const :name, String
+    const :house, String
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      name == other.name && house == other.house
+    end
+
+    def eql?(other)
+      self == other
+    end
+  end
+
+  shared_examples 'pluck_to_tstruct' do |struct_type, expected_values|
+    it 'plucks correctly from ActiveRecord model' do
+      plucked = Wizard.pluck_to_tstruct(TA[struct_type].new)
+      expect(plucked).to match_array(expected_values)
+    end
+
+    it 'plucks correctly from ActiveRecord relation' do
+      plucked = Wizard.all.pluck_to_tstruct(TA[struct_type].new)
+      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"),
+      WizardName.new(name: "Hermione Granger"),
+    ]
+  end
+
+  context 'pluck multiple attributes' do
+    it_should_behave_like 'pluck_to_tstruct', WizardT, [
+      WizardT.new(name: "Harry Potter", house: "Gryffindor"),
+      WizardT.new(name: "Hermione Granger", house: "Gryffindor"),
+    ]
+  end
+
+  context 'given a wrong type' do
+    it 'should raise error' do
+      expect {
+        plucked = Wizard.pluck_to_tstruct(TA[String].new)
+      }.to raise_error(SorbetRails::PluckToTStruct::UnexpectedType)
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -13,8 +13,6 @@ rails_version = ENV["RAILS_VERSION"] || "default"
 
 rails_folder =
   case rails_version
-  when "4.2"
-    "v4.2"
   when "5.0"
     "v5.0"
   when "5.1"

data/spec/rake_rails_rbi_models_spec.rb

@@ -44,6 +44,7 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
     expect_files(
       base_dir: generated_dir_path,
       files: [
+        'squib.rbi',
         'wizard.rbi',
       ]
     )
@@ -55,6 +56,7 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
       base_dir: generated_dir_path,
       files: [
         'spell_book.rbi',
+        'squib.rbi',
         'wizard.rbi',
       ]
     )

data/spec/sorbet_utils_spec.rb

@@ -33,6 +33,13 @@ class SorbetUtilsExampleClass
   def method_with_block_return(&p1); end
 
   def method_without_sig(p1, p2, *p3, p4:, **p5, &p6); end
+
+  sig { params(p1: String, p2: String, p3: Integer).void }
+  def method_with_default(p1, p2='abc', p3: 123); end
+
+  def method_with_missing_args_name(p1, *); end
+
+  def method_with_missing_kwargs_name(p1, **); end
 end
 
 RSpec.describe SorbetRails::SorbetUtils do
@@ -123,4 +130,34 @@ RSpec.describe SorbetRails::SorbetUtils do
       Parameter.new('&p6', type: 'T.untyped'),
     ])
   end
+
+  # TODO it doesn't know how to extract default values from method yet
+  # Would have to rely on reading & parsing the source code :(
+  # it 'works when method arguments have default' do
+  #   method_def = SorbetUtilsExampleClass.instance_method(:method_with_default)
+  #   parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+  #   expect(parameters).to match_array([
+  #     Parameter.new('p1', type: 'T.untyped'),
+  #     Parameter.new('p2', type: 'T.untyped', default: '"abc"'),
+  #     Parameter.new('p3:', type: 'T.untyped', default: '123'),
+  #   ])
+  # end
+
+  it 'works when method args doesnt have name' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_missing_args_name)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T.untyped'),
+      Parameter.new('*_', type: 'T.untyped'),
+    ])
+  end
+
+  it 'works when method kwargs doesnt have name' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_missing_kwargs_name)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T.untyped'),
+      Parameter.new('**_', type: 'T.untyped'),
+    ])
+  end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,9 @@
 require "byebug"
 require "simplecov"
 
-SimpleCov.start
-
 if ENV["CI"] == "true"
   require "codecov"
+  SimpleCov.start
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.5.6)
+    sorbet-rails (0.5.7)
       parlour (~> 0.8.0)
 
 GEM
@@ -68,7 +68,7 @@ GEM
     nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    parlour (0.8.0)
+    parlour (0.8.1)
       rainbow (~> 3.0.0)
       sorbet-runtime
     puma (3.12.1)
@@ -100,10 +100,10 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    sorbet (0.4.4761)
-      sorbet-static (= 0.4.4761)
-    sorbet-runtime (0.4.4761)
-    sorbet-static (0.4.4761-universal-darwin-14)
+    sorbet (0.4.4775)
+      sorbet-static (= 0.4.4775)
+    sorbet-runtime (0.4.4775)
+    sorbet-static (0.4.4775-universal-darwin-14)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/spec/support/v5.0/config/boot.rb

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: strict
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.

data/spec/support/v5.0/config/initializers/sorbet_rails.rb

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

data/spec/support/v5.0/db/migrate/20190620000004_add_more_column_types_to_wands.rb

@@ -9,7 +9,7 @@ class AddMoreColumnTypesToWands < ActiveRecord::Migration[5.0]
     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

data/spec/support/v5.0/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

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.5.6)
+    sorbet-rails (0.5.7)
       parlour (~> 0.8.0)
 
 GEM
@@ -69,7 +69,7 @@ GEM
     nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    parlour (0.8.0)
+    parlour (0.8.1)
       rainbow (~> 3.0.0)
       sorbet-runtime
     puma (3.12.1)
@@ -101,10 +101,10 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    sorbet (0.4.4761)
-      sorbet-static (= 0.4.4761)
-    sorbet-runtime (0.4.4761)
-    sorbet-static (0.4.4761-universal-darwin-14)
+    sorbet (0.4.4775)
+      sorbet-static (= 0.4.4775)
+    sorbet-runtime (0.4.4775)
+    sorbet-static (0.4.4775-universal-darwin-14)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/spec/support/v5.1/config/boot.rb

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: strict
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.

data/spec/support/v5.1/config/initializers/sorbet_rails.rb

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

data/spec/support/v5.1/db/migrate/20190620000004_add_more_column_types_to_wands.rb

@@ -9,7 +9,7 @@ class AddMoreColumnTypesToWands < ActiveRecord::Migration[5.1]
     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

data/spec/support/v5.1/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

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.5.5.1)
+    sorbet-rails (0.5.7)
       parlour (~> 0.8.0)
 
 GEM
@@ -76,7 +76,7 @@ GEM
     nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    parlour (0.8.0)
+    parlour (0.8.1)
       rainbow (~> 3.0.0)
       sorbet-runtime
     puma (3.12.1)
@@ -109,10 +109,10 @@ GEM
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    sorbet (0.4.4761)
-      sorbet-static (= 0.4.4761)
-    sorbet-runtime (0.4.4761)
-    sorbet-static (0.4.4761-universal-darwin-14)
+    sorbet (0.4.4775)
+      sorbet-static (= 0.4.4775)
+    sorbet-runtime (0.4.4775)
+    sorbet-static (0.4.4775-universal-darwin-14)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)