sorbet-rails 0.6.3 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ade7fadcb2cc5890f8cd5716247f14d7d9b0324029fb13de4f8b902e205a516
-  data.tar.gz: 766dfdd66acea268fe696345ae871bf4b88cd67e2b845dffeb9f218d9a38586d
+  metadata.gz: cc9807ef098eeb05a61378ffe82fa56864f5d0543ba20031153bd86ac604a356
+  data.tar.gz: e9fa8ed4c3390685d352486d3bde21b4301ce3f9d1b600b79198aba797bee560
 SHA512:
-  metadata.gz: 91ce6f173680ed297198333b0780c4f4257a7b95d56f33d6f464f67f122c37a6483b87f00392792219ce51724ad5379fea9b7cbf91fc100d439396f828f210be
-  data.tar.gz: ba26ebc1b34724a1eee5cc667add0b843c3ef77994606938e31b2f3fc0a0a88d8a0b7ad39f65194350045166c1eb130cd94951f54c763d82a7efd19dd65ed7a0
+  metadata.gz: 0374a3b24474fbf04051edfdf372b11132dcd4293d9cca7a1a692e15e63aad07a55d5f72c10830bb96799aa31d175ffd20584d81c58bbee2b4c293c27ddcc33f
+  data.tar.gz: a8826daddfef144295b9df4438e669e7cf42d494666d47073f7868b6481c329b9e8058cc2d308598c0d34035065d6b2f1c7611113a85c5a0b8912f91af363d3c

data/.gitattributes

@@ -1,4 +1,3 @@
-lib/sorbet/* linguist-generated
 spec/test_data/* linguist-generated
 spec/support/* linguist-generated
-
+sorbet/* linguist-generated

data/.gitignore

@@ -79,6 +79,7 @@ build-iPhoneSimulator/
 /spec/support/**/config/credentials.yml.enc
 
 # Ignore sorbet generated files
+/sorbet/rbi/hidden-definitions/
 /spec/support/**/sorbet/*
 /spec/support/**/sorbet/**/*
 
@@ -93,7 +94,7 @@ build-iPhoneSimulator/
 *.swl
 *.swk
 
-lib/sorbet/rbi/hidden-definitions/errors.txt
+sorbet/rbi/hidden-definitions/errors.txt
 .vscode
 
 .rake_tasks~

data/.travis.yml

@@ -16,7 +16,7 @@ rvm:
 matrix:
   include:
   - rvm: 2.5
-    env: RAILS_VERSION=5.2 SORBET_VERSION=0.5.5400
+    env: RAILS_VERSION=5.2 SORBET_VERSION=0.5.5737
   exclude:
   - rvm: 2.3
     env: RAILS_VERSION=6.0
@@ -24,6 +24,8 @@ matrix:
     env: RAILS_VERSION=6.0
   allow_failures:
   - rvm: ruby-head
+  - rvm: 2.7
+    env: RAILS_VERSION=6.0
 before_install:
 - gem install bundler -v 2.0.1 --no-doc
 - gem install bundler -v 1.17.3 --no-doc

data/README.md

@@ -73,7 +73,7 @@ It is possible to add custom RBI generation logic for your custom module or gems
 We also add following methods to make type-checking more easily:
 - [`find_n`, `first_n`, `last_n`](https://github.com/chanzuckerberg/sorbet-rails#find-first-and-last)
 - [`pluck_to_tstruct`](#pluck_to_tstruct-instead-of-pluck)
-- [`typed_enum`](#enums)
+- [`typed_enum`](#typed_enum-instead-of-enum)
 - [`Model::RelationType`](#relationtype-alias)
 
 #### `pluck_to_tstruct` instead of `pluck`
@@ -94,9 +94,31 @@ Wizard.pluck_to_tstruct(TA[WizardStruct].new)  # T::Array[WizardStruct]
 Wizard.all.pluck_to_tstruct(TA[WizardStruct].new)  # T::Array[WizardStruct]
 ```
 
+You can also pass a keyword argument called `associations` that represents a mapping of a `T::Struct`'s keys to an associated table's columns.
+```ruby
+# -- API
+Arel.pluck_to_tstruct(TA[ <TStructSubclass> ].new, associations: < Hash<Symbol, String> >)
+
+# -- example
+class WizardWithWandStruct < T::Struct
+  const :name, String
+  const :house, T.nilable(String)
+  const :wand_wood_type, String
+end
+
+Wizard.joins(:wand).pluck_to_tstruct(
+  TA[WizardWithWandStruct].new,
+  associations: { wand_wood_type: "wands.wood_type" }
+)
+Wizard.all.joins(:wand).pluck_to_tstruct(
+  TA[WizardWithWandStruct].new,
+  associations: { wand_wood_type: "wands.wood_type" }
+)
+````
+
 This method is based on [pluck_to_hash](https://github.com/girishso/pluck_to_hash) gem.
 
-#### Enums
+#### `typed_enum` instead of `enum`
 
 If you use [Rails `enum`](https://guides.rubyonrails.org/active_record_querying.html#enums), `sorbet-rails` will generate a corresponding `T::Enum`. It will also include getters, setters, and scope methods in the rbi file it generates.
 
@@ -203,7 +225,7 @@ end
 If it fails to coerce the params into the right type, an `ActionController::BadRequest` exception will be raised with the coercion context for debugging.
 
 Note: The API `TypedParams[...].new.extract!` may seem verbose, but necessary to support this feature. Ideally, the API can be simply `TypedParams.extract!(...)`. However, `sorbet` [doesn't support](http://github.com/sorbet/sorbet/issues/62) defining a method that accept a type and return an instance of the type. If this feature is supported by `sorbet` in the future, it will be easy to codemod to be `TypedParams.extract(...)!` part from your code.
-Note: [`require_typed` and `fetch_typed`](https://github.com/chanzuckerberg/sorbet-rails/blob/v0.5.9.1/README.md) are deprecated in favor of `TypedParams`.
+Note: [`require_typed` and `fetch_typed`](https://github.com/chanzuckerberg/sorbet-rails/blob/v0.5.9.1/README.md) are deprecated in favor of `TypedParams`. They will be removed in v0.7.
 
 ### Routes
 
@@ -412,11 +434,13 @@ If you run into the following issue when running rspec, it's likely because you'
        if you're really stuck.
 ```
 
-## Extending Model Generation Task with Custom Plugins
+## Extending RBI Generation logic
+
+### Extending Model Generation Task with Custom Plugins
 
 `sorbet-rails` support a customizable plugin system that you can use to generate additional RBI for each model. This will be useful to generate RBI for methods dynamically added by gems or private concerns. If you write plugins for public gems, please feel free to contribute it to this repo.
 
-### Defining a Custom `ModelPlugin`
+#### Defining a Custom `ModelPlugin`
 
 A custom plugin should be a subclass of `SorbetRails::ModelPlugins::Base`. Each plugin would implement a `generate(root)` method that generate additional rbi for the model.
 
@@ -465,14 +489,14 @@ It is also recommended to check if the generated methods are detected by `sorbet
 
 Check out the [plugins](https://github.com/chanzuckerberg/sorbet-rails/tree/master/lib/sorbet-rails/model_plugins) written for `sorbet-rails`'s own model RBI generation logic for examples.
 
-### Registering new plugins
+#### Registering new plugins
 You can register your plugins in an initializer:
 ```ruby
 # -- config/initializers/sorbet_rails.rb
 SorbetRails::ModelRbiFormatter.register_plugin(MyCustomPlugin)
 ```
 
-### Enabling built-in plugins
+#### Enabling built-in plugins
 
 sorbet-rails comes with a handful of gem plugins that can be enabled in an initializer. You can pass enabled gem plugins to `config.enabled_gem_plugins`, like so:
 
@@ -508,6 +532,29 @@ You can also configure the core model plugins if needed. The default plugins are
 [active_flag]: https://github.com/kenn/active_flag
 [Paperclip]: https://github.com/thoughtbot/paperclip
 
+### Customize Generation Class
+
+For mailer and job rbi generation, you can customize the logic by
+setting the generation class in the config:
+
+```ruby
+SorbetRails.configure do |config|
+  config.job_generator_class = CustomJobRbiGenerator
+  config.mailer_generator_class = CustomMailerRbiGenerator
+end
+```
+
+The custom generator can subclass the [provided generators](lib/bundled_rbi/customizabel_rbi_formatter.rbi) and override the populate_rbi method. For example:
+
+```ruby
+class CustomJobRbiGenerator < SorbetRails::JobRbiFormatter
+  def populate_rbi
+    rbi_generator.root.add_comment("== Custom Generator ==")
+    super
+  end
+end
+```
+
 ## Contributing
 
 Contributions and ideas are welcome! Please see [our contributing guide](CONTRIBUTING.md) and don't hesitate to open an issue or send a pull request to improve the functionality of this gem.

data/Rakefile

@@ -20,9 +20,9 @@ namespace :update_spec do
   task :v6_0 do |t, args|
     Bundler.with_clean_env do
       FileUtils.rm_rf 'spec/support/v6.0' if File.directory?('spec/support/v6.0')
-      system("gem install rails -v 6.0.0")
-      system("rails _6.0.0_ -v")
-      system("RAILS_VERSION='6.0' rails _6.0.0_ new --template spec/generators/rails-template.rb spec/support/v6.0 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
+      system("gem install rails -v 6.0.3")
+      system("rails _6.0.3_ -v")
+      system("RAILS_VERSION='6.0' rails _6.0.3_ new --template spec/generators/rails-template.rb spec/support/v6.0 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
     end
   end
 

data/lib/bundled_rbi/customizabel_rbi_formatter.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+module SorbetRails
+  class MailerRbiFormatter
+    extend T::Sig
+    Parameter = ::Parlour::RbiGenerator::Parameter
+
+    sig { returns(T.class_of(ActionMailer::Base)) }
+    attr_reader :mailer_class
+
+    sig { returns(Parlour::RbiGenerator) }
+    def rbi_generator; end
+
+    sig { void }
+    def populate_rbi; end
+  end
+
+  class JobRbiFormatter
+    Parameter = ::Parlour::RbiGenerator::Parameter
+
+    sig { returns(Parlour::RbiGenerator) }
+    attr_reader :rbi_generator
+
+    sig { returns(T.class_of(ActiveJob::Base)) }
+    attr_reader :job_class
+
+    sig { void }
+    def populate_rbi; end
+  end
+end

data/lib/bundled_rbi/pluck_to_tstruct.rbi

@@ -6,10 +6,11 @@ module SorbetRails::PluckToTStruct
     type_parameters(:U).
     params(
       ta_struct: ITypeAssert[T.type_parameter(:U)],
+      associations: T::Hash[Symbol, String],
     ).
     returns(T::Array[T.type_parameter(:U)])
   }
-  def pluck_to_tstruct(ta_struct, &blk); end
+  def pluck_to_tstruct(ta_struct, associations: {}); end
 end
 
 class ActiveRecord::Base

data/lib/bundled_rbi/typed_enum.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+module ActiveRecord::Enum
+
+  sig { params(definitions: T::Hash[Symbol, T.untyped]).void }
+  def typed_enum(definitions); end
+
+end

data/lib/sorbet-rails.rb

@@ -1,11 +1,9 @@
-# typed: strong
+# typed: strict
 module SorbetRails
   if defined?(Rails)
     require 'sorbet-rails/railtie'
     require 'sorbet-rails/model_rbi_formatter'
     require 'sorbet-rails/type_assert/type_assert'
-    require 'sorbet-rails/custom_types/integer_string'
-    require 'sorbet-rails/custom_types/boolean_string'
     require 'sorbet-rails/typed_params'
   end
 end

data/lib/sorbet-rails/active_record_rbi_formatter.rb

@@ -85,11 +85,18 @@ class SorbetRails::ActiveRecordRbiFormatter
       # parameters than the ones defined by `create_elem_specific_query_methods` so
       # we need to match the signatures in that conflicting rbi.
       build_methods = %w(new build create create!)
+      # This needs to match the generated method signature in activerecord.rbi and
+      # in Rails 5.0 and 5.1 the param is a splat.
+      if Rails.version =~ /^5\./
+        build_param = Parameter.new("*args", type: "T.untyped")
+      else
+        build_param = Parameter.new("attributes", type: "T.untyped", default: 'nil')
+      end
       build_methods.each do |build_method|
         class_rbi.create_method(
           build_method,
           parameters: [
-            Parameter.new("*args", type: "T.untyped"),
+            build_param,
             Parameter.new(
               "&block",
               type: "T.nilable(T.proc.params(object: Elem).void)",
@@ -264,7 +271,6 @@ class SorbetRails::ActiveRecordRbiFormatter
         ],
         return_type: "T::Enumerator[#{inner_type}]",
         class_method: class_method,
-        override: true,
       )
     end
   end

data/lib/sorbet-rails/config.rb

@@ -1,4 +1,7 @@
 # typed: true
+require("sorbet-rails/mailer_rbi_formatter")
+require("sorbet-rails/job_rbi_formatter")
+
 module SorbetRails
   class << self
     extend T::Sig
@@ -37,6 +40,12 @@ module SorbetRails
     sig { returns(T::Array[String]) }
     attr_accessor :extra_helper_includes
 
+    sig { returns(T.class_of(SorbetRails::JobRbiFormatter))}
+    attr_accessor :job_generator_class
+
+    sig { returns(T.class_of(SorbetRails::MailerRbiFormatter))}
+    attr_accessor :mailer_generator_class
+
     sig { void }
     def initialize
       @enabled_gem_plugins = []
@@ -52,6 +61,8 @@ module SorbetRails
       ]
       @enabled_model_plugins << :active_storage_methods if defined?(T.unsafe(ActiveStorage))
       @extra_helper_includes = []
+      @mailer_generator_class = SorbetRails::MailerRbiFormatter
+      @job_generator_class = SorbetRails::JobRbiFormatter
     end
 
     sig { returns(T::Array[Symbol]) }

data/lib/sorbet-rails/deprecation.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'active_support/deprecation'
 
 module SorbetRails

data/lib/sorbet-rails/gem_plugins/active_flag_plugin.rb

@@ -7,7 +7,6 @@ class ActiveFlagPlugin < SorbetRails::ModelPlugins::Base
 
     module_name = self.model_module_name("GeneratedActiveFlagMethods")
     module_rbi = root.create_module(module_name)
-    module_rbi.create_extend("T::Sig")
 
     model_class_rbi = root.create_class(self.model_class_name)
     model_class_rbi.create_include(module_name)

data/lib/sorbet-rails/gem_plugins/kaminari_plugin.rb

@@ -35,5 +35,13 @@ class KaminariPlugin < SorbetRails::ModelPlugins::Base
         Parameter.new('num', type: 'Integer')
       ],
     )
+
+    # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-core/lib/kaminari/models/configuration_methods.rb#L19
+    model_class_rbi = root.create_class(model_class_name)
+    model_class_rbi.create_method(
+      "default_per_page",
+      return_type: "Integer",
+      class_method: true,
+    )
   end
 end

data/lib/sorbet-rails/gem_plugins/paperclip_plugin.rb

@@ -8,7 +8,6 @@ class PaperclipPlugin < SorbetRails::ModelPlugins::Base
 
     module_name = self.model_module_name("GeneratedPaperclipMethods")
     module_rbi = root.create_module(module_name)
-    module_rbi.create_extend("T::Sig")
 
     model_class_rbi = root.create_class(self.model_class_name)
     model_class_rbi.create_include(module_name)

data/lib/sorbet-rails/job_rbi_formatter.rb

@@ -2,74 +2,85 @@
 require('parlour')
 require('sorbet-rails/sorbet_utils.rb')
 
-class SorbetRails::JobRbiFormatter
-  extend T::Sig
+module SorbetRails
+  class JobRbiFormatter
+    extend T::Sig
 
-  Parameter = ::Parlour::RbiGenerator::Parameter
+    Parameter = ::Parlour::RbiGenerator::Parameter
 
-  sig { params(job_class: T.class_of(ActiveJob::Base)).void }
-  def initialize(job_class)
-    @job_class = T.let(job_class, T.class_of(ActiveJob::Base))
-    @parlour = T.let(Parlour::RbiGenerator.new, Parlour::RbiGenerator)
-  end
+    sig { returns(Parlour::RbiGenerator) }
+    attr_reader :rbi_generator
+
+    sig { returns(T.class_of(ActiveJob::Base)) }
+    attr_reader :job_class
 
-  sig {returns(String)}
-  def generate_rbi
-    puts "-- Generate sigs for mailer #{@job_class.name} --"
+    sig { params(job_class: T.class_of(ActiveJob::Base)).void }
+    def initialize(job_class)
+      @job_class = T.let(job_class, T.class_of(ActiveJob::Base))
+      @rbi_generator = T.let(Parlour::RbiGenerator.new, Parlour::RbiGenerator)
+    end
 
-    @parlour.root.add_comments([
-      'This is an autogenerated file for Rails\' jobs.',
-      'Please rerun bundle exec rake rails_rbi:jobs to regenerate.'
-    ])
+    sig { void }
+    def populate_rbi
+      @rbi_generator.root.add_comments([
+        'This is an autogenerated file for Rails\' jobs.',
+        'Please rerun bundle exec rake rails_rbi:jobs to regenerate.'
+      ])
 
-    @parlour.root.create_class(@job_class.name) do |job_rbi|
-      method_def = @job_class.instance_method(:perform)
-      parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
-      job_rbi.create_method(
-        "perform_later",
-        parameters: parameters,
-        class_method: true,
-      )
-      job_rbi.create_method(
-        "perform_now",
-        parameters: parameters,
-        class_method: true,
-      )
-      # Override the signature for "set" so that we can support it
-      # At run-time, this method returns a `ActiveJob::ConfiguredJob` but
-      # we fake the signature to return "T.self_class" so that
-      # sorbet can type-check when `perform_later` is called on it
-      # See: https://guides.rubyonrails.org/active_job_basics.html#enqueue-the-job
-      job_rbi.create_method(
-        "set",
-        # Documentation: https://api.rubyonrails.org/classes/ActiveJob/Core/ClassMethods.html
-        parameters: [
-          Parameter.new(
-            "wait:",
-            type: "T.nilable(ActiveSupport::Duration)",
-            default: "nil",
-          ),
-          Parameter.new(
-            "wait_until:",
-            type: "T.nilable(T.any(ActiveSupport::TimeWithZone, Date, Time))",
-            default: "nil",
-          ),
-          Parameter.new(
-            "queue:",
-            type: "T.nilable(T.any(String, Symbol))",
-            default: "nil",
-          ),
-          Parameter.new(
-            "priority:",
-            type: "T.nilable(Integer)",
-            default: "nil",
-          ),
-        ],
-        return_type: "T.self_type",
-        class_method: true,
-      )
+      @rbi_generator.root.create_class(@job_class.name) do |job_rbi|
+        method_def = @job_class.instance_method(:perform)
+        parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+        job_rbi.create_method(
+          "perform_later",
+          parameters: parameters,
+          class_method: true,
+        )
+        job_rbi.create_method(
+          "perform_now",
+          parameters: parameters,
+          class_method: true,
+        )
+        # Override the signature for "set" so that we can support it
+        # At run-time, this method returns a `ActiveJob::ConfiguredJob` but
+        # we fake the signature to return "T.self_class" so that
+        # sorbet can type-check when `perform_later` is called on it
+        # See: https://guides.rubyonrails.org/active_job_basics.html#enqueue-the-job
+        job_rbi.create_method(
+          "set",
+          # Documentation: https://api.rubyonrails.org/classes/ActiveJob/Core/ClassMethods.html
+          parameters: [
+            Parameter.new(
+              "wait:",
+              type: "T.nilable(ActiveSupport::Duration)",
+              default: "nil",
+            ),
+            Parameter.new(
+              "wait_until:",
+              type: "T.nilable(T.any(ActiveSupport::TimeWithZone, Date, Time))",
+              default: "nil",
+            ),
+            Parameter.new(
+              "queue:",
+              type: "T.nilable(T.any(String, Symbol))",
+              default: "nil",
+            ),
+            Parameter.new(
+              "priority:",
+              type: "T.nilable(Integer)",
+              default: "nil",
+            ),
+          ],
+          return_type: "T.self_type",
+          class_method: true,
+        )
+      end
     end
 
-    @parlour.rbi
+    sig { returns(String) }
+    def generate_rbi
+      puts "-- Generate sigs for mailer #{@job_class.name} --"
+      populate_rbi
+      @rbi_generator.rbi
+    end
   end
 end