sorbet-rails 0.2.0 → 0.3.0

data/lib/sorbet-rails/routes_rbi_formatter.rb

@@ -15,21 +15,13 @@ class RoutesRbiFormatter
   def header(routes)
   end
 
-  def no_routes(routes, filter=nil)
-    puts routes
+  def no_routes(routes=nil, filter=nil)
     @buffer <<
-      if routes.none?
-        <<~MESSAGE
-          # You do not have any routes defined!
-          # Please add some routes in config/routes.rb.
-        MESSAGE
-      elsif filter && filter.key?(:controller)
-        "# No routes were found for this controller."
-      elsif filter && filter.key?(:grep)
-        "# No routes were found for this grep pattern."
-      end
-
-    @buffer << "# For more information about routes, see the Rails guide: https://guides.rubyonrails.org/routing.html."
+      <<~MESSAGE
+        # You do not have any routes defined!
+        # Please add some routes in config/routes.rb.
+        # For more information about routes, see the Rails guide: https://guides.rubyonrails.org/routing.html.
+      MESSAGE
   end
 
   def result

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

@@ -18,12 +18,12 @@ namespace :rails_rbi do
   task models: :environment do |t, args|
     # need to eager load to see all models
     Rails.application.eager_load!
+    # Rails 6.0 change the loading logic to use Zeitwerk
+    # https://github.com/rails/rails/blob/master/railties/lib/rails/application/finisher.rb#L116
+    # But this is not applied to Rails.application.eager_load! method
+    Zeitwerk::Loader.eager_load_all if defined?(Zeitwerk)
 
-    blacklisted_models = []
-    blacklisted_models << ActiveRecord::SchemaMigration if defined?(ActiveRecord::SchemaMigration)
-    blacklisted_models << ApplicationRecord if defined?(ApplicationRecord)
-
-    all_models = ActiveRecord::Base.descendants - blacklisted_models
+    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) } :
@@ -54,8 +54,15 @@ namespace :rails_rbi do
 
   def blacklisted_models
     blacklisted_models = []
-    blacklisted_models << ActiveRecord::SchemaMigration if defined?(ActiveRecord::SchemaMigration)
     blacklisted_models << ApplicationRecord if defined?(ApplicationRecord)
     blacklisted_models
   end
+
+  def whitelisted_models
+    # force generating these models because they aren't loaded with eager_load!
+    whitelisted_models = []
+    whitelisted_models << ActiveRecord::InternalMetadata if Object.const_defined?('ActiveRecord::InternalMetadata')
+    whitelisted_models << ActiveRecord::SchemaMigration if Object.const_defined?('ActiveRecord::SchemaMigration')
+    whitelisted_models
+  end
 end

data/rbi/activerecord.rbi

@@ -5,7 +5,7 @@ class ActiveRecord::Relation
   include Enumerable
   include ActiveRecord::Querying::Typed
 
-  Elem = type_member
+  Elem = type_member(fixed: ActiveRecord::Base)
 
   sig { params(block: T.proc.params(e: Elem).void).void }
   def each(&block); end
@@ -21,14 +21,14 @@ class ActiveRecord::Relation
   # TODO normally this method could return Elem or Array[Elem]
   # however, we think it's better to limit the interface to returning Elem only
   # Use `find_n` as a replacement if you want to get an array from `find`
-  sig { params(args: T.untyped).returns(Elem).soft }
+  sig { params(args: T.untyped).returns(Elem) }
   def find(*args); end
 end
 
 class ActiveRecord::Associations::CollectionProxy < ActiveRecord::Relation
   extend T::Generic
 
-  Elem = type_member
+  Elem = type_member(fixed: ActiveRecord::Base)
 
   # -- << and aliases
   sig { params(records: T.any(Elem, T::Array[Elem])).returns(T.self_type) }
@@ -45,7 +45,7 @@ end
 module ActiveRecord::Querying::Typed
   extend T::Sig
   extend T::Generic
-  Elem = type_member
+  Elem = type_member(fixed: ActiveRecord::Base)
 
   # -- Booleans
   sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
@@ -94,13 +94,13 @@ module ActiveRecord::Querying::Typed
   # array of element when there is a limit passed in.
   # The more common use case is to find 1 object. We use that as the default sig
   # and add custom first_n, last_n method for the cases that return an array
-  sig { params(limit: T.nilable(Integer)).returns(T.nilable(Elem)).soft }
+  sig { params(limit: T.nilable(Integer)).returns(T.nilable(Elem)) }
   def first(limit = nil); end
-  sig { params(limit: T.nilable(Integer)).returns(T.nilable(Elem)).soft }
+  sig { params(limit: T.nilable(Integer)).returns(T.nilable(Elem)) }
   def last(limit = nil); end
   # Similar to first & last, normally this method could return Elem or Array[Elem]
   # But we enforce that `find` return Elem by default and provide find_n as an alternative
-  sig { params(args: T.any(Integer, String)).returns(Elem).soft }
+  sig { params(args: T.any(Integer, String)).returns(Elem) }
   def find(*args); end
   # These are custom finder methods to provide strong type for secondary use case of first, last & find
   # See sorbet_rails/custom_finder_methods
@@ -142,9 +142,34 @@ class ActiveRecord::Base
   extend ActiveRecord::Querying::Typed
   extend T::Generic
   Elem = type_template(fixed: ActiveRecord::Base)
+  include ActiveRecord::AttributeMethods::Dirty
+  include ActiveModel::Dirty
 end
 
 class ApplicationRecord
   extend T::Generic
   Elem = type_template(fixed: ApplicationRecord)
 end
+
+module ActiveModel::Dirty
+  extend T::Sig
+
+  sig { params(attr: Symbol, from: T.untyped, to: T.untyped).returns(T::Boolean) }
+  def attribute_changed?(attr, from: nil, to: nil); end
+
+  sig { params(attr_name: Symbol).returns(T::Boolean) }
+  def attribute_changed_in_place?(attr_name); end
+
+  sig { params(attr_name: Symbol).returns(T::Boolean) }
+  def attribute_previously_changed?(attr_name); end
+
+  sig { returns(T::Boolean) }
+  def changed?; end
+end
+
+module ActiveRecord::AttributeMethods::Dirty
+  extend T::Sig
+
+  sig { params(attr_name: Symbol, options: T.untyped).returns(T::Boolean) }
+  def saved_change_to_attribute?(attr_name, **options); end
+end

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.2.0"
+  s.version       = "0.3.0"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]
@@ -22,9 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'byebug', '~>11.0.1', '>=11.0.1'
 
   # for testing a gem with a rails app (controller specs)
-  s.add_development_dependency 'bundler', '>=1.3.0'
   s.add_development_dependency 'rspec-rails', '>=3.8.2'
-  s.add_development_dependency 'sqlite3', '>=1.4.1'
   s.add_development_dependency 'puma', '>=3.12.1'
-  s.add_development_dependency 'listen', '>=3.1.5'
+  s.add_development_dependency 'database_cleaner', '>= 1.7.0'
 end

data/spec/bin/install.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+# A simple script to run bundle install
+
+case $RAILS_VERSION in
+  4.2)
+    RAILS_VERSION=4.2 bundle _1.17.3_ install --jobs=3 --retry=3
+    ;;
+  *)
+    bundle install --jobs=3 --retry=3
+    ;;
+esac

data/spec/bin/run_all_specs.sh

@@ -1,9 +1,13 @@
 #!/bin/bash
-# A simple script to run all specs for all Rails versions
+# A simple script to run all specs for all supported Rails branches
 
-# 5.1.7
-RAILS_VERSION=5.1.7 bundle update && RAILS_VERSION=5.1.7 bundle exec rake
+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=5.2 bash $wd/run_spec.sh
+RAILS_VERSION=6.0 bash $wd/run_spec.sh
 
 # Always end with the default version
-# 5.2.3
-bundle update && bundle exec rake
+sh $wd/run_spec.sh

data/spec/bin/run_spec.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+# A simple script to run spec for a single version of Rails
+
+# need to use bash so that $wd returns the location of the script
+wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+rm $wd/../../Gemfile.lock 2>/dev/null # clean up Gemfile.lock first
+
+case $RAILS_VERSION in
+  4.2)
+    echo 'run spec with Rails 4.2'
+    RAILS_VERSION=4.2 bundle _1.17.3_ update && RAILS_VERSION=4.2 bundle _1.17.3_ exec rake
+    ;;
+  5.0)
+    echo 'run spec with Rails 5.0'
+    RAILS_VERSION=5.0 bundle update && RAILS_VERSION=5.0 bundle exec rake
+    ;;
+  5.1)
+    echo 'run spec with Rails 5.1'
+    RAILS_VERSION=5.1 bundle update && RAILS_VERSION=5.1 bundle exec rake
+    ;;
+  5.2)
+    echo 'run spec with Rails 5.2'
+    RAILS_VERSION=5.2 bundle update && RAILS_VERSION=5.2 bundle exec rake
+    ;;
+  6.0)
+    echo 'run spec with Rails 6.0'
+    RAILS_VERSION=6.0 bundle update && RAILS_VERSION=6.0 bundle exec rake
+    ;;
+  *)
+    echo 'run default'
+    bundle update && bundle exec rake
+    ;;
+esac

data/spec/bin/{reset_test_data.sh → update_test_data.sh}

@@ -2,4 +2,5 @@
 # A simple script to reset test data for all Rails versions
 
 wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-RESET_TEST_DATA=true sh $wd/run_all_specs.sh
+
+RESET_TEST_DATA=true bash $wd/run_all_specs.sh

data/spec/custom_finder_methods_spec.rb

@@ -0,0 +1,75 @@
+require 'rails_helper'
+
+RSpec.describe SorbetRails::CustomFinderMethods do
+  let!(:harry) do
+    Wizard.create!(
+      name: 'Harry Potter',
+      house: :Gryffindor,
+    )
+  end
+  let!(:ron) do
+    Wizard.create!(
+      name: 'Ron Weasley',
+      house: :Gryffindor,
+    )
+  end
+  let!(:hermione) do
+    Wizard.create!(
+      name: 'Hermione Granger',
+      house: :Gryffindor,
+    )
+  end
+  let!(:wizard_ids) { Wizard.all.pluck(:id) }
+
+  context 'test find_n' do
+    it 'works with array input' do
+      with_array = Wizard.find_n(wizard_ids)
+      expect(with_array.size).to eql(3)
+    end
+
+    it 'works with multiple ids' do
+      with_splash = Wizard.find_n(*wizard_ids)
+      expect(with_splash.size).to eql(3)
+    end
+
+    it 'works with single id array' do
+      with_one_element = Wizard.find_n([wizard_ids.first])
+      expect(with_one_element.size).to eql(1)
+    end
+
+    it 'works with string ids' do
+      with_array_string = Wizard.find_n(wizard_ids.map(&:to_s))
+      expect(with_array_string.size).to eql(3)
+    end
+  end
+
+  context 'test first_n' do
+    it 'handles n = 1' do
+      first_wizard = Wizard.order(:id).first_n(1)
+      expect(first_wizard).to eq([harry])
+    end
+
+    it 'handles n > 1' do
+      wizards_2 = Wizard.order(:id).first_n(2)
+      expect(wizards_2).to eq([harry, ron])
+
+      wizards_3 = Wizard.order(:id).first_n(3)
+      expect(wizards_3).to eq([harry, ron, hermione])
+    end
+  end
+
+  context 'test last_n' do
+    it 'handles n = 1' do
+      last_wizard = Wizard.order(:id).last_n(1)
+      expect(last_wizard).to eq([hermione])
+    end
+
+    it 'handles n > 1' do
+      wizards_2 = Wizard.order(:id).last_n(2)
+      expect(wizards_2).to eq([ron, hermione])
+
+      wizards_3 = Wizard.order(:id).first_n(3)
+      expect(wizards_3).to eq([harry, ron, hermione])
+    end
+  end
+end

data/spec/model_rbi_formatter_spec.rb

@@ -4,16 +4,18 @@ require 'sorbet-rails/model_rbi_formatter'
 RSpec.describe ModelRbiFormatter do
 
   it 'loads all the models in the app' do
-    Rails.application.eager_load!
-    all_models = ActiveRecord::Base.descendants.sort_by(&:name)
-    expect(all_models).to eql([
-      ActiveRecord::SchemaMigration,
-      ApplicationRecord,
+    expected_models = [
       Potion,
       SpellBook,
       Wand,
       Wizard,
-    ])
+    ]
+
+    Rails.application.eager_load!
+    # Needed for Rails 6.0
+    Zeitwerk::Loader.eager_load_all if defined?(Zeitwerk)
+    all_models = ActiveRecord::Base.descendants
+    expect((expected_models - all_models)).to eql([])
   end
 
   it 'does not throw an error when given an abstract class' do

data/spec/rails_helper.rb

@@ -7,17 +7,22 @@ require 'rake'
 require 'rspec/rails'
 require 'sorbet-rails/railtie'
 require 'rspec/expectations'
-
-load 'sorbet-rails/tasks/rails_rbi.rake'
+require 'database_cleaner'
 
 rails_version = ENV["RAILS_VERSION"] || "default"
 
 rails_folder =
   case rails_version
-  when "5.1.7"
-    "5.1.7"
+  when "4.2"
+    "v4.2"
+  when "5.0"
+    "v5.0"
+  when "5.1"
+    "v5.1"
+  when "6.0"
+    "v6.0"
   else
-    "5.2.3"
+    "v5.2"
   end
 
 TEST_DATA_FOLDER = "spec/test_data/#{rails_folder}"
@@ -26,6 +31,28 @@ require "support/#{rails_folder}/config/environment"
 
 ActiveRecord::Migration.maintain_test_schema!
 
+RSpec.configure do |config|
+  config.before(:suite) do
+    next if ENV["DISABLE_DATABASE_CLEANER"] == 'true'
+    DatabaseCleaner.clean_with(:truncation, {pre_count: true, reset_ids: false})
+  end
+
+  config.around(:each) do |example|
+    if ENV["DISABLE_DATABASE_CLEANER"] == 'true'
+      example.run
+      next
+    end
+    if example.metadata.fetch(:transaction, true)
+      DatabaseCleaner.strategy = :transaction
+    else
+      DatabaseCleaner.strategy = :truncation, {pre_count: true, reset_ids: false}
+    end
+    DatabaseCleaner.start
+    example.run
+    DatabaseCleaner.clean
+  end
+end
+
 def expect_match_file(content, file_path)
   # TODO make this a custom matcher that can be shared in multiple files
   relative_path = "#{TEST_DATA_FOLDER}/#{file_path}"

data/spec/rake_helper.rb

@@ -0,0 +1,47 @@
+# For testing rake tasks
+# From: https://github.com/eliotsykes/rails-testing-toolbox/blob/master/tasks.rb
+# Checkout: https://www.eliotsykes.com/test-rails-rake-tasks-with-rspec
+
+require 'rake'
+
+# Task names should be used in the top-level describe, with an optional
+# "rake "-prefix for better documentation. Both of these will work:
+#
+# 1) describe 'foo:bar' do ... end
+#
+# 2) describe 'rake foo:bar' do ... end
+#
+# Favor including 'rake '-prefix as in the 2nd example above as it produces
+# doc output that makes it clear a rake task is under test and how it is
+# invoked.
+module TaskExampleGroup
+  extend ActiveSupport::Concern
+
+  included do
+    let(:task_name) { self.class.top_level_description.sub(/\Arake /, '') }
+    let(:tasks) { Rake::Task }
+    subject(:task) { tasks[task_name] }
+
+    after(:each) do
+      task.all_prerequisite_tasks.each { |prerequisite| tasks[prerequisite].reenable }
+      task.reenable
+
+      # clean up generated dir
+      rbi_dir = Rails.root.join("sorbet", "rails-rbi")
+      FileUtils.remove_dir(rbi_dir) if Dir.exists?(rbi_dir)
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+  config.define_derived_metadata(:file_path => %r{/spec/tasks/}) do |metadata|
+    metadata[:type] = :task
+  end
+
+  config.include TaskExampleGroup, type: :task
+
+  config.before(:suite) do
+    Rails.application.load_tasks
+  end
+end