sorbet-rails 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf5c9e5cc4d021af0e9206c53d9682288bb204f85179bffc2f041b2b783f8c8
-  data.tar.gz: 72de625982952376be79c47926266d7d25767b3b015b463c9302e75421643278
+  metadata.gz: 2b140547379c65a11d38f65b8f1947e8d14e904e17a45d3a47d00898414cfecc
+  data.tar.gz: 491a878f313376278994b35ae9a1fd2a62408be09572167f92d4ea822da54562
 SHA512:
-  metadata.gz: 3e59b36bf6be3ee5f8eb15db96a0b51a624557a4c1debebfeffe49b764b9670763e4437b6eba08137995126c07d150898f0cdceaa486b103f265929917a514ad
-  data.tar.gz: 5ae9763e3c5d1bafbfe6d847077abd8af4a7a80cabaa626ed723a66a036f8cc383dd26e242bffb055adedf40f5ee000d40394cadb405dd23c5dd1449748a722c
+  metadata.gz: ffa8138e362bb2b8799826fc14b39cc2bd0e213e56e9aa2e783e476cd1d92b84561be6844bf2cca573339f432815fa9d95ba3aef3d88fbba78d226d3edf43f3a
+  data.tar.gz: 03c4a2fcc89ac330c883a098b44864bf3bff7170d0b929c84e4a38e3b806be322f988babaef8508f87c8dcf41ae4d1bb1859df05a2dfd4343ea24ea4395b2e8f

data/.gitignore

@@ -73,8 +73,10 @@ build-iPhoneSimulator/
 /spec/support/**/public/assets
 .byebug_history
 
-# Ignore master key for decrypting credentials and more.
+# Ignore master key for decrypting credentials and the secrets.yml that was used in older versions of Rails.
 /spec/support/**/config/master.key
+/spec/support/**/config/secrets.yml
+/spec/support/**/config/credentials.yml.enc
 
 # Ignore sorbet-rails generated files
 /spec/support/**/sorbet/rails-rbi/*
@@ -87,6 +89,9 @@ build-iPhoneSimulator/
 /spec/support/v5.2-no-sorbet/sorbet/*
 /spec/support/v5.2-no-sorbet/sorbet/**/*
 
+# Ignore files in the public/ directories.
+/spec/support/**/public/*
+
 # editor swap files
 *.swp
 *.swo

data/.travis.yml

@@ -19,7 +19,7 @@ matrix:
   - rvm: 2.5
     env: RAILS_VERSION=5.2 SORBET_VERSION=0.4.4602
   - rvm: 2.5
-    env: TEST_SRB_INIT=true
+    env: RAILS_VERSION=5.2 TEST_SRB_INIT=true
   exclude:
   - rvm: 2.3
     env: RAILS_VERSION=6.0

data/CONTRIBUTING.md

@@ -62,7 +62,10 @@ The most important files are:
    Generates RBI files for models. You can regenerate these using `bundle exec rake rails_rbi:models`.
 
  * [`lib/sorbet-rails/routes_rbi_formatter.rb`](lib/sorbet-rails/routes_rbi_formatter.rb):
-   Generates an RBI files for routes.  You can regenerate these using `bundle exec rake rails_rbi:routes`.
+   Generates an RBI file for routes. You can regenerate this using `bundle exec rake rails_rbi:routes`.
+
+ * [`lib/sorbet-rails/helper_rbi_formatter.rb`](lib/sorbet-rails/helper_rbi_formatter.rb):
+   Generates an RBI file for helpers. You can regenerate this using `bundle exec rake rails_rbi:helpers`.
 
 ## Tests
 
@@ -109,19 +112,21 @@ execution to stop, which will then start a debugger. For more, check out the
 
 ### Writing Tests
 
-Tests are in the `_spec.rb` files in the [`spec/`](spec/) directory. Sorbet's `srb tc` test cases are in [`spec/support/rails_shared/sorbet_test_cases.rb`](spec/support/rails_shared/sorbet_test_cases.rb).
-
-Rails apps are stored in [`spec/support/`](spec/support/). Code shared across Rails versions
-(models, views, controllers) are in [`spec/support/rails_shared/`](spec/support/rails_shared/)
-and symlinked to the individual Rails apps.
+Tests are in the `_spec.rb` files in the [`spec/`](spec/) directory. Sorbet's `srb tc` test
+cases are in [`spec/generators/sorbet_test_cases.rb`](spec/generators/sorbet_test_cases.rb).
 
-To update the routes, see
-[`rails_shared/config/routes.rb`](spec/support/rails_shared/config/routes.rb)
-and [`rails_shared/app/controller/`](spec/support/rails_shared/app/controller/).
+Rails apps are stored in [`spec/support/`](spec/support/). All models,
+controllers, helpers, migrations, and any other shared code comes
+from [`spec/generators/rails-template.rb`](spec/generators/rails-template.rb).
+The only exception to this is `spec/generators/sorbet_test_cases.rb`, which is
+copied into each app with `cp`.
 
-To update the models, see [`rails_shared/app/models/`](spec/support/rails_shared/app/models/).
-Add database migrations to [`rails_shared/db/migrate/`](spec/support/rails_shared/db/migrate/)
-and remember to run `bundle exec rake db:migrate` in each application directory.
+The `rails-template.rb` file uses the
+[Rails Application Template](https://guides.rubyonrails.org/rails_application_templates.html)
+functionality included in Rails. You can then regenerate each Rails app from
+the same file using `bundle _1.17.3_ exec rake update_spec:v4.2`, `bundle exec rake update_spec:v5.0`,
+`bundle exec rake update_spec:v5.1`, etc. (or just `bundle exec rake update_spec:v5_plus`,
+though this excludes regenerating 4.2 because 4.2 blocks usage of Bundler 2.x).
 
 #### Expected Output
 
@@ -135,3 +140,7 @@ by running:
 Only do this once you're confident that your code is correct, because it will update
 the expected test data stored in [`spec/test_data/`](spec/test_data/) based on your current
 code, and all tests will then pass.
+
+If you want to update `sorbet_test_cases.rb`, you can run `bundle exec rake update_spec:sorbet_test_cases`
+to copy the file from `spec/generators/sorbet_test_cases.rb` into each of the Rails apps
+in `spec/support/`.

data/Rakefile

@@ -4,3 +4,84 @@ require 'bundler/gem_tasks'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+namespace :update_spec do
+  require 'fileutils'
+
+  # This excludes 4.2 because it won't work with Bundler 2.0
+  desc "Generate Rails apps for all versions (except 4.2)."
+  task :v5_plus do |t, args|
+    Rake::Task['update_spec:v6_0'].invoke
+    Rake::Task['update_spec:v5_2'].invoke
+    Rake::Task['update_spec:v5_2_no_sorbet'].invoke
+    Rake::Task['update_spec:v5_1'].invoke
+    Rake::Task['update_spec:v5_0'].invoke
+  end
+
+  desc "Delete the Rails 6 spec directory and regenerate it."
+  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.rc2")
+      system("rails _6.0.0.rc2_ -v")
+      system("RAILS_VERSION='6.0' rails _6.0.0.rc2_ 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
+
+  desc "Delete the Rails 5.2 spec directory and regenerate it."
+  task :v5_2 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v5.2' if File.directory?('spec/support/v5.2')
+      system("gem install rails -v 5.2.3")
+      system("rails _5.2.3_ -v")
+      system("RAILS_VERSION='5.2' rails _5.2.3_ new --template spec/generators/rails-template.rb spec/support/v5.2 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
+    end
+  end
+
+  desc "Delete the Rails 5.2-no-sorbet spec directory and regenerate it."
+  task :v5_2_no_sorbet do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v5.2-no-sorbet' if File.directory?('spec/support/v5.2-no-sorbet')
+      system("gem install rails -v 5.2.3")
+      system("rails _5.2.3_ -v")
+      system("RUN_WITH_SORBET='false' RAILS_VERSION='5.2' rails _5.2.3_ new --template spec/generators/rails-template.rb spec/support/v5.2-no-sorbet --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
+    end
+  end
+
+  desc "Delete the Rails 5.1 spec directory and regenerate it."
+  task :v5_1 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v5.1' if File.directory?('spec/support/v5.1')
+      system("gem install rails -v 5.1.7")
+      system("rails _5.1.7_ -v")
+      system("RAILS_VERSION='5.1' rails _5.1.7_ new --template spec/generators/rails-template.rb spec/support/v5.1 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-listen")
+    end
+  end
+
+  desc "Delete the Rails 5.0 spec directory and regenerate it."
+  task :v5_0 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v5.0' if File.directory?('spec/support/v5.0')
+      system("gem install rails -v 5.0.7")
+      system("rails _5.0.7_ -v")
+      system("RAILS_VERSION='5.0' rails _5.0.7_ new --template spec/generators/rails-template.rb spec/support/v5.0 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-listen")
+    end
+  end
+
+  desc "Delete the Rails 4.2 spec directory and regenerate it."
+  task :v4_2 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v4.2' if File.directory?('spec/support/v4.2')
+      system("gem install rails -v 4.2.11")
+      system("rails _4.2.11_ -v")
+      system("RAILS_VERSION='4.2' rails _4.2.11_ new --template spec/generators/rails-template.rb spec/support/v4.2 --skip-javascript --skip-test --skip-sprockets --skip-spring --skip-listen")
+    end
+  end
+
+  desc "Update sorbet_test_cases.rb in all the Rails apps in spec/support."
+  task :sorbet_test_cases do |t, args|
+    ['v6.0', 'v5.2', 'v5.2-no-sorbet', 'v5.1', 'v5.0', 'v4.2'].each do |version|
+      FileUtils.cp("spec/generators/sorbet_test_cases.rb", "spec/support/#{version}/sorbet_test_cases.rb")
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+class KaminariPlugin < SorbetRails::ModelPlugins::Base
+  # Kaminari generates a dynamic `page` method on ActiveRecord relations.
+  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-activerecord/lib/kaminari/activerecord/active_record_model_extension.rb#L15
+  sig { params(root: Parlour::RbiGenerator::Namespace).void.implementation }
+  def generate(root)
+    return unless @model_class.include?(Kaminari::ActiveRecordModelExtension)
+
+    # Get the configured Kaminari page method name, or fall back to 'page' if necessary.
+    page_method = T.unsafe(Kaminari).config.page_method_name || 'page'
+
+    ar_querying_rbi = root.create_module(model_relation_shared_module_name)
+    ar_querying_rbi.create_method(
+      page_method.to_s,
+      parameters: [
+        Parameter.new('num', type: 'T.nilable(Integer)', default: 'nil')
+      ],
+      return_type: model_relation_class_name
+    )
+  end
+end

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

@@ -49,15 +49,19 @@ namespace :rails_rbi do
     end
 
     # If ApplicationController doesn't work or doesn't return any helpers,
-    # use ActionController::Base.
-    if ActionController::Base.methods.include?(:modules_for_helpers) && (helpers.length == 0 || helpers.nil?)
+    # try using ActionController::Base.
+    if ActionController::Base.methods.include?(:modules_for_helpers) && (helpers.nil? || helpers.length == 0)
       helpers = ActionController::Base.modules_for_helpers([:all])
     end
 
-    formatter = SorbetRails::HelperRbiFormatter.new(helpers)
-    file_path = Rails.root.join("sorbet", "rails-rbi", "helpers.rbi")
-    FileUtils.mkdir_p(File.dirname(file_path))
-    File.write(file_path, formatter.generate_rbi)
+    if helpers.nil? || helpers.length == 0
+      puts 'No helpers found.'
+    else
+      formatter = SorbetRails::HelperRbiFormatter.new(helpers)
+      file_path = Rails.root.join("sorbet", "rails-rbi", "helpers.rbi")
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.write(file_path, formatter.generate_rbi)
+    end
   end
 
   def generate_rbis_for_models(model_classes, available_classes)

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.5.0"
+  s.version       = "0.5.1"
   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_spec.sh

@@ -32,9 +32,9 @@ cd $current_dir
 
 if [[ -z $RAILS_VERSION ]]; then
   echo "---- Run DEFAULT ----"
-  bundle update && bundle exec rake
+  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 bundle $bundle_version exec rake
+  RAILS_VERSION=$RAILS_VERSION DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle $bundle_version exec rake
 fi

data/spec/generators/rails-template.rb

@@ -0,0 +1,268 @@
+# Generate a Rails app.
+# Use the rake tasks in this repository to generate the Rails apps.
+
+def add_gems
+  gem 'sorbet-rails', path: '../../../.'
+
+  sorbet_version = ENV["SORBET_VERSION"]
+  if sorbet_version
+    # mostly used to test against a stable version of Sorbet in Travis.
+    gem 'sorbet', sorbet_version
+    gem 'sorbet-runtime', sorbet_version
+  else
+    # prefer to test against latest version because sorbet is updated frequently
+    gem 'sorbet'
+    gem 'sorbet-runtime'
+  end
+end
+
+def add_routes
+  route "get 'test/index' => 'test#index'"
+end
+
+def create_initializers
+  initializer "sorbet_rails.rb", <<~RUBY
+    # typed: strict
+    require(Rails.root.join('lib/mythical_rbi_plugin'))
+    SorbetRails::ModelRbiFormatter.register_plugin(MythicalRbiPlugin)
+  RUBY
+end
+
+def create_lib
+  lib "mythical_rbi_plugin.rb", <<~'RUBY'
+    # typed: true
+    class MythicalRbiPlugin < SorbetRails::ModelPlugins::Base
+      def generate(root)
+        return unless @model_class.include?(Mythical)
+
+        model_class_rbi = root.create_class(self.model_class_name)
+
+        # ActiveSupport::Concern class method will be inserted to the class
+        # directly. We need to also put the sig in the model class rbi directly
+        model_class_rbi.create_method(
+          'mythicals',
+          class_method: true,
+          return_type: "T::Array[#{@model_class.name}]",
+        )
+      end
+    end
+  RUBY
+end
+
+def create_helpers
+  file "app/helpers/foo_helper.rb", <<~RUBY
+    module FooHelper
+    end
+  RUBY
+
+  file "app/helpers/bar_helper.rb", <<~RUBY
+    module BarHelper
+    end
+  RUBY
+
+  file "app/helpers/baz_helper.rb", <<~RUBY
+    module BazHelper
+    end
+  RUBY
+end
+
+def create_models
+  if ENV['RAILS_VERSION'] != '4.2'
+    inject_into_file "app/models/application_record.rb", after: "self.abstract_class = true\n" do
+      # Need to include indentation manually
+      "  scope :recent, -> { where('created_at > ?', 1.month.ago) }\n"
+    end
+  else
+    file "app/models/application_record.rb", <<~RUBY
+      class ApplicationRecord < ActiveRecord::Base
+        self.abstract_class = true
+        scope :recent, -> { where('created_at > ?', 1.month.ago) }
+      end
+    RUBY
+  end
+
+  file "app/models/spell_book.rb", <<~RUBY
+    class SpellBook < ApplicationRecord
+      validates :name, length: { minimum: 5 }, presence: true
+      belongs_to :wizard
+    end
+  RUBY
+
+  file "app/models/potion.rb", <<~RUBY
+    # an abstract class that has no table
+    class Potion < ApplicationRecord
+      self.abstract_class = true
+    end
+  RUBY
+
+  file "app/models/wand.rb", <<~RUBY
+    class Wand < ApplicationRecord
+      include Mythical
+    
+      enum core_type: {
+        phoenix_feather: 0,
+        dragon_heartstring: 1,
+        unicorn_tail_hair: 2,
+        basilisk_horn: 3,
+      }
+    
+      belongs_to :wizard
+    
+      def wood_type
+        'Type ' + super
+      end
+    end
+  RUBY
+
+  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,
+      }
+
+      has_one :wand
+      has_many :spell_books
+    end
+  RUBY
+
+  file "app/models/concerns/mythical.rb", <<~RUBY
+    require 'active_support/concern'
+    module Mythical
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def mythicals
+          all.to_a # yeah!
+        end
+      end
+    end
+  RUBY
+end
+
+def create_migrations
+  if ENV["RAILS_VERSION"] == "4.2"
+    migration_superclass = 'ActiveRecord::Migration'
+  else
+    migration_superclass = "ActiveRecord::Migration[#{ENV['RAILS_VERSION']}]"
+  end
+
+  file "db/migrate/20190620000001_create_wizards.rb", <<~RUBY
+    class CreateWizards < #{migration_superclass}
+      def change
+        create_table :wizards do |t|
+          t.string :name
+          t.integer :house
+          t.string :parent_email
+          t.text :notes
+    
+          t.timestamps
+        end
+      end
+    end
+  RUBY
+
+  file "db/migrate/20190620000002_create_wands.rb", <<~RUBY
+    class CreateWands < #{migration_superclass}
+      def change
+        create_table :wands do |t|
+          t.references :wizard, unique: true, null: false
+          t.string :wood_type
+          t.integer :core_type
+    
+          t.timestamps
+        end
+      end
+    end
+  RUBY
+
+  file "db/migrate/20190620000003_create_spell_books.rb", <<~RUBY
+    class CreateSpellBooks < #{migration_superclass}
+      def change
+        create_table :spell_books do |t|
+          t.string :name
+          t.references :wizard
+        end
+      end
+    end
+  RUBY
+
+  file "db/migrate/20190620000004_add_more_column_types_to_wands.rb", <<~RUBY
+    class AddMoreColumnTypesToWands < #{migration_superclass}
+      def change
+        add_column :wands, :flexibility,    :float,   null: false, default: 0.5
+        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, :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'])
+          add_column :wands, :spell_history,  :json
+          add_column :wands, :maker_info,     :json,    null: false, default: '{}'
+        end
+      end
+    end
+  RUBY
+end
+
+def add_sorbet_test_files
+  file "typed-override.yaml", <<~YAML
+    true:
+    - ./sorbet_test_cases.rb
+  YAML
+
+  copy_file "./sorbet_test_cases.rb", "sorbet_test_cases.rb"
+end
+
+# Get files relative to this template when copying.
+def source_paths
+  [__dir__]
+end
+
+# Main setup
+source_paths
+
+if ['4.2', '5.0'].include?(ENV["RAILS_VERSION"])
+  File.open('Gemfile', 'r+') do |f|   
+    out = ""
+    f.each do |line|
+      # We remove sdoc and web-console because they misbehave.
+      # sqlite needs to be limited to 1.3.x or it won't work.
+      out << line.gsub("gem 'sqlite3'", "gem 'sqlite3', '~> 1.3.6'") unless line =~ /gem \'(sdoc|web-console)\'.*/
+    end
+    f.pos = 0
+    f.print out
+    f.truncate(f.pos)
+  end
+end
+
+add_gems
+
+after_bundle do
+  say "Creating application..."
+  add_routes
+  create_initializers
+  create_lib
+  create_helpers
+  create_models
+  create_migrations
+  add_sorbet_test_files
+  
+  Bundler.with_clean_env do
+    # Rails 4.2 doesn't have the rails_command method, so just use run.
+    run "bundle exec rake db:migrate"
+  end
+
+  if ENV["RUN_WITH_SORBET"] != 'false'
+    Bundler.with_clean_env do
+      run "SRB_YES=true bundle exec srb init"
+      run "bundle exec rake rails_rbi:all"
+    end
+  end
+  say "Done!"
+end