sorbet-rails 0.1.2 → 0.1.3

data/lib/sorbet-rails/model_rbi_formatter.rb

@@ -286,7 +286,7 @@ class ModelRbiFormatter
 
   def type_for_column_def(column_def)
     strict_type = RUBY_TO_SORBET_TYPE_MAPPING[column_def.type] || 'T.untyped'
-    if column_def.array?
+    if column_def.respond_to?(:array?) && column_def.array?
       strict_type = "T::Array[#{strict_type}]"
     end
     column_def.null ? "T.nilable(#{strict_type})" : strict_type

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

@@ -0,0 +1,60 @@
+require("sorbet-rails/model_rbi_formatter")
+require("sorbet-rails/routes_rbi_formatter")
+
+namespace :rails_rbi do
+
+  desc "Generate rbi for rails routes"
+  task :routes, [:root_dir] => :environment do |t, args|
+    all_routes = Rails.application.routes.routes
+    require "action_dispatch/routing/inspector"
+    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+    root_dir = args[:root_dir] || Rails.root
+    file_path = Rails.root.join("sorbet", "rails-rbi", "routes.rbi")
+    FileUtils.mkdir_p(File.dirname(file_path))
+    File.write(file_path, inspector.format(RoutesRbiFormatter.new))
+  end
+
+  desc "Generate rbi for rails models. Pass models name to regenrate rbi for only the given models."
+  task models: :environment do |t, args|
+    # need to eager load to see all models
+    Rails.application.eager_load!
+
+    blacklisted_models = []
+    blacklisted_models << ActiveRecord::SchemaMigration if defined?(ActiveRecord::SchemaMigration)
+
+    all_models = ActiveRecord::Base.descendants - blacklisted_models
+
+    models_to_generate = args.extras.size > 0 ?
+      args.extras.map { |m| Object.const_get(m) } :
+      all_models
+
+    generated_rbis = generate_rbis_for_models(models_to_generate, all_models)
+    generated_rbis.each do |model_name, contents|
+      file_path = Rails.root.join("sorbet", "rails-rbi", "models", "#{model_name.underscore}.rbi")
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.write(file_path, contents)
+    end
+  end
+
+  def generate_rbis_for_models(model_classes, available_classes)
+    available_class_names = Set.new(available_classes.map { |c| c.name })
+    formatted = model_classes.map do |model_class|
+      begin
+        formatter = ModelRbiFormatter.new(model_class, available_class_names)
+        [model_class.name, formatter.generate_rbi]
+      rescue StandardError => ex
+        puts "---"
+        puts "Error when handling model #{model_class.name}: #{ex}"
+        nil
+      end
+    end
+    Hash[formatted.compact] # remove models with errors
+  end
+
+  def blacklisted_models
+    blacklisted_models = []
+    blacklisted_models << ActiveRecord::SchemaMigration if defined?(ActiveRecord::SchemaMigration)
+    blacklisted_models << ApplicationRecord if defined?(ApplicationRecord)
+    blacklisted_models
+  end
+end

data/rbis/activerecord.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+class ActiveRecord::Relation
+  extend T::Sig
+  extend T::Generic
+  include Enumerable
+  include ActiveRecord::Querying::Typed
+
+  Elem = type_member
+
+  sig { params(block: T.proc.params(e: Elem).void).void }
+  def each(&block); end
+
+  sig { params(level: T.nilable(Integer)).returns(T::Array[Elem]) }
+  def flatten(level); end
+
+  sig { returns(T::Array[Elem]) }
+  def to_a; end
+
+  # This is part of both FinderMethods & Enumerable module.
+  # We need to define here to override the typedef in Enumerable module.
+  # 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 }
+  def find(*args); end
+end
+
+module ActiveRecord::Querying::Typed
+  extend T::Sig
+  extend T::Generic
+  Elem = type_member
+
+  # -- Booleans
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
+  def exists?(*args, &block); end
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
+  def any?(*args, &block); end
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
+  def many?(*args, &block); end
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
+  def none?(*args, &block); end
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T::Boolean) }
+  def one?(*args, &block); end
+
+  # -- finder methods
+  sig { returns(Elem) }
+  def first!; end
+  sig { returns(Elem) }
+  def second!; end
+  sig { returns(T.nilable(Elem)) }
+  def second; end
+  sig { returns(Elem) }
+  def third!; end
+  sig { returns(T.nilable(Elem)) }
+  def third; end
+  sig { returns(Elem) }
+  def fourth!; end
+  sig { returns(T.nilable(Elem)) }
+  def fourth; end
+  sig { returns(Elem) }
+  def fifth!; end
+  sig { returns(T.nilable(Elem)) }
+  def fifth; end
+
+  sig { returns(Elem) }
+  def last!; end
+  sig { returns(Elem) }
+  def third_to_last!; end
+  sig { returns(T.nilable(Elem)) }
+  def third_to_last; end
+  sig { returns(Elem) }
+  def second_to_last!; end
+  sig { returns(T.nilable(Elem)) }
+  def second_to_last; end
+
+  # These methods would return 1 single element when there is no limit, and return an
+  # 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 }
+  def first(limit = nil); end
+  sig { params(limit: T.nilable(Integer)).returns(T.nilable(Elem)).soft }
+  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 }
+  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
+  sig { params(limit: Integer).returns(T::Array[Elem]) }
+  def first_n(limit); end
+  sig { params(limit: Integer).returns(T::Array[Elem]) }
+  def last_n(limit); end
+  sig { params(args: T::Array[T.any(Integer, String)]).returns(T::Array[Elem]) }
+  def find_n(*args); end
+
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(T.nilable(Elem)) }
+  def find_by(*args, &block); end
+
+  sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(Elem) }
+  def find_by!(*args, &block); end
+
+  sig { params(id: Integer).returns(T.nilable(Elem)) }
+  def find_by_id(id); end
+
+  sig { params(id: Integer).returns(Elem) }
+  def find_by_id!(id); end
+
+  # -- Calculation
+  # There can be a complication of using count with .group
+  # https://api.rubyonrails.org/classes/ActiveRecord/Calculations.html#method-i-count
+  # sig { params(args: T.untyped, block: T.nilable(T.proc.void)).returns(Integer) }
+  # def count(*args, &block); end
+end
+
+module ActiveRecord::QueryMethods
+  # TODO: where.not is a special case that we replace it with a `where_not` method
+  # `where` when not given parameters will return a `ActiveRecord::QueryMethods::WhereChain`
+  # instance that has a method `not` on it
+  sig { params(opts: T.untyped, rest: T.untyped).returns(T.self_type) }
+  def not(opts = nil, *rest); end
+end
+
+class ActiveRecord::Base
+  extend ActiveRecord::Querying::Typed
+  extend T::Generic
+  Elem = type_template(fixed: ActiveRecord::Base)
+end
+
+class ApplicationRecord
+  extend T::Generic
+  Elem = type_template(fixed: ApplicationRecord)
+end

data/sorbet-rails.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name          = %q{sorbet-rails}
+  s.version       = "0.1.3"
+  s.date          = %q{2019-04-18}
+  s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
+  s.authors       = ["Chan Zuckerberg Initiative"]
+  s.email         = "opensource@chanzuckerberg.com"
+  s.homepage      = "https://github.com/chanzuckerberg/sorbet-rails"
+  s.license       = 'MIT'
+  s.require_paths = ["lib"]
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.test_files    = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  # Development
+  s.add_development_dependency 'rspec', '~> 3.8', '>= 3.8'
+  # Debugging
+  s.add_development_dependency 'awesome_print', '~>1.8.0', '>=1.8.0'
+  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', '>=1.3.0'
+  s.add_development_dependency 'rails', '~>5.2.3', '>=5.2.3'
+  s.add_development_dependency 'rspec-rails', '~>3.8.2', '>=3.8.2'
+  s.add_development_dependency 'sqlite3', '~>1.4.1', '>=1.4.1'
+  s.add_development_dependency 'puma', '~>3.12.1', '>=3.12.1'
+  s.add_development_dependency 'listen', '~>3.1.5', '>=3.1.5'
+end

data/spec/model_rbi_formatter_spec.rb

@@ -0,0 +1,54 @@
+require 'rails_helper'
+require 'sorbet-rails/model_rbi_formatter'
+
+RSpec.describe ModelRbiFormatter do
+
+  def expect_match_file(content, file_path, save_to_file: false)
+    # TODO make this a custom matcher that can be shared in multiple files
+    if save_to_file
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.write(file_path, content)
+    end
+    expected_value = File.read(file_path)
+    expect(content).to eql(expected_value)
+  end
+
+  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,
+      SpellBook,
+      Wand,
+      Wizard,
+    ])
+  end
+
+  it 'generates correct rbi file for Wizard' do
+    formatter = ModelRbiFormatter.new(Wizard, ['Wizard', 'Wand', 'SpellBook'])
+    expect_match_file(
+      formatter.generate_rbi,
+      'spec/test_data/models/expected_wizard.rbi',
+    )
+  end
+
+  it 'generates strict belongs_to and do not generate overridden methods' do
+    formatter = ModelRbiFormatter.new(Wand, ['Wizard', 'Wand', 'SpellBook'])
+    expect_match_file(
+      formatter.generate_rbi,
+      'spec/test_data/models/expected_wand.rbi',
+      save_to_file: true,
+    )
+  end
+
+  context 'there is a hidden model' do
+    it 'fallbacks to use ActiveRecord::Relation' do
+      formatter = ModelRbiFormatter.new(Wizard, ['Wizard', 'Wand'])
+      expect_match_file(
+        formatter.generate_rbi,
+        'spec/test_data/models/expected_wizard_wo_spellbook.rbi',
+      )
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+ENV['RAILS_ENV'] = 'test'
+
+require 'rails/all'
+require 'rake'
+require 'rspec/rails'
+require 'sorbet-rails/railtie'
+
+load 'sorbet-rails/tasks/rails_rbi.rake'
+
+require 'support/rails_app/config/environment'
+
+ActiveRecord::Migration.maintain_test_schema!

data/spec/routes_rbi_formatter_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+require 'sorbet-rails/routes_rbi_formatter'
+
+RSpec.describe RoutesRbiFormatter do
+  it 'sets up Rails Application' do
+    expect(Rails.application.routes).to_not be_empty
+  end
+
+  it 'generates _path and _url of a named route' do
+    all_routes = Rails.application.routes.routes
+    require "action_dispatch/routing/inspector"
+    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+    formatted = inspector.format(RoutesRbiFormatter.new)
+    # Write the res to a file
+    # file_path = '/tmp/expected_routes.rbi'
+    # FileUtils.mkdir_p(File.dirname(file_path))
+    # File.write(file_path, res)
+    expected_value = File.read('spec/test_data/expected_routes.rbi')
+    expect(formatted).to eql(expected_value)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "byebug"
+require "simplecov"
+
+SimpleCov.start
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end

data/spec/support/rails_app/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/spec/support/rails_app/Gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.4.3'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.3'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.11'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use ActiveStorage variant
+# gem 'mini_magick', '~> 4.8'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Reduces boot times through caching; required in config/boot.rb
+# gem 'bootsnap', '>= 1.1.0', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  # gem 'spring'
+  # gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/spec/support/rails_app/Gemfile.lock

@@ -0,0 +1,139 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    ffi (1.11.1)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    puma (3.12.1)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    ruby_dep (1.5.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  listen (>= 3.0.5, < 3.2)
+  puma (~> 3.11)
+  rails (~> 5.2.3)
+  sqlite3
+  tzinfo-data
+
+RUBY VERSION
+   ruby 2.4.3p205
+
+BUNDLED WITH
+   2.0.1