rbs_rails 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc75e64602e5966e87f1bfe2b9530034f81999715b5d9e3697f4f424af9a6da
-  data.tar.gz: 5d742b05e28d190c940d44585883be713133095d17d5778c6e64fbf2ef3b3719
+  metadata.gz: 5dd350161bbcf1358c43fbda2fb5b42aa106b42a14f079a26e60338e9ccbae92
+  data.tar.gz: b5a700311050c8500037f70be69d652c96bbf20ebc0334ad49d7c97964b977ec
 SHA512:
-  metadata.gz: 5b07cb43cba9d2bf51beddbfdb45ad4c2e29bc6c80d6301259af7b289c8ab832b2908bbb4d96594cf7ca7d9318c54481c11daf07d6d20dc3826518b40f5b5144
-  data.tar.gz: 2af365f0d0c891d677bd60f4322566aec9897edd93585dfc6871f5ad5923985f9fe8503520b884f98382c5954ca5ab2ce1ec35ed674727449305f35ca1260c02
+  metadata.gz: 414a6a9fa8feb585dbae5826c68e9043eedeb3b4e1c43d112efdcdcb61c10686d18dc76d57191c34f456ec43c36246cb4c096ceb59dba7cdf0bba4f10a5e4159
+  data.tar.gz: da5d5c7f919d5b2dedfb596bb8e207210ee9a3391db6af13372cc976b57f3ba89ca4b8a19578847f538b4b6adfd547c634f261ac8e21030f2ec98dee3e15147e

data/.gitignore

@@ -7,3 +7,6 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+/test/app/sig/rbs_rails
+/test/app/sig/app
+/test/app/sig/path_helpers.rbs

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gem_rbs"]
+	path = gem_rbs
+	url = https://github.com/ruby/gem_rbs.git

data/.travis.yml

@@ -5,4 +5,7 @@ rvm:
   - 2.7.0
   - ruby-head
 
+before_install:
+  - gem install bundler -v 2.1.4
+
 cache: bundler

data/Gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem 'rbs', '>= 0.4.0'
-gem 'steep'
+gem 'rbs', '1.0.0'
+gem 'steep', '>= 0.34.0', git: 'https://github.com/soutaro/steep.git'
+gem 'minitest'

data/README.md

@@ -7,7 +7,7 @@ RBS files generator for Ruby on Rails.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rbs_rails'
+gem 'rbs_rails', require: false
 ```
 
 And then execute:
@@ -20,57 +20,55 @@ Or install it yourself as:
 
 ## Usage
 
-### For Active Record models
+Put the following code to `lib/tasks/rbs.rake`.
 
-It has two tasks.
+```ruby
+require 'rbs_rails/rake_task'
 
-* `copy_signature_files`: Copy type definition files for Rails from rbs_rails.
-* `generate_rbs_for_model`: Generate RBS files from model classes.
+RbsRails::RakeTask.new
+```
 
-```ruby
-# Rakefile
+Then, the following four tasks are available.
+
+* `rbs_rails:copy_signature_files`: Copy RBS files for rbs_rails
+* `rbs_rails:generate_rbs_for_models`: Generate RBS files for Active Record models
+* `rbs_rails:generate_rbs_for_path_helpers`: Generate RBS files for path helpers
+* `rbs_rails:all`: Execute all tasks of RBS Rails
 
-task copy_signature_files: :environment do
-  require 'rbs_rails'
 
-  to = Rails.root.join('sig/rbs_rails/')
-  to.mkpath unless to.exist?
-  RbsRails.copy_signatures(to: to)
-end
 
-task generate_rbs_for_model: :environment do
-  require 'rbs_rails'
 
-  out_dir = Rails.root / 'sig'
-  out_dir.mkdir unless out_dir.exist?
+### Steep integration
 
-  Rails.application.eager_load!
+You need to specify the following libraries by `Steepfile`.
 
-  ActiveRecord::Base.descendants.each do |klass|
-    next if klass.abstract_class?
+```ruby
+# Steepfile
 
-    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-    FileUtils.mkdir_p(path.dirname)
+target :app do
+  signature 'sig'
 
-    sig = RbsRails::ActiveRecord.class_to_rbs(klass, mode: :extension)
-    path.write sig
-  end
-end
-```
+  check 'app'
 
-### For path helpers
+  repo_path "path/to/rbs_repo"
 
-```ruby
-# Rakefile
+  library 'pathname'
+  library 'logger'
+  library 'mutex_m'
+  library 'date'
 
-task generate_rbs_for_path_helpers: :environment do
-  require 'rbs_rails'
-  out_path = Rails.root.join 'sig/path_helpers.rbs'
-  rbs = RbsRails::PathHelpers.generate
-  out_path.write rbs
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
 end
 ```
 
+You need to put RBS repo to `path/to/rbs_repo`. See https://github.com/ruby/gem_rbs
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,7 +1,20 @@
 require "bundler/gem_tasks"
-task :default => :steep
+require 'rake/testtask'
+
+task :default => [:rbs_validate, :steep, :test]
 
 desc 'run Steep'
 task :steep do
   sh 'steep', 'check'
 end
+
+task :rbs_validate do
+  rbs = Pathname(__dir__).join('bin/rbs').to_s
+  sh "ruby #{rbs} validate --silent"
+end
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = Dir['test/**/*_test.rb']
+  test.verbose = true
+end

data/Steepfile

@@ -3,7 +3,18 @@ target :lib do
   signature 'assets/sig'
 
   check "lib"                       # Directory name
+  repo_path ENV['RBS_REPO_DIR'] || './gem_rbs/gems'
 
   library "pathname"
-  # library "strong_json"           # Gems
+  library "logger"
+  library "mutex_m"
+  library "date"
+
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
 end

data/assets/sig/action_mailer.rbs

@@ -1,5 +1,8 @@
-class ActionMailer::Base
-  extend ActionView::Layouts::ClassMethods
+module ActionMailer
+  class Base
+    # TODO
+    # extend ActionView::Layouts::ClassMethods
 
-  def self.default: (?Hash[Symbol, untyped] value) -> Hash[Symbol, untyped]
+    def self.default: (?Hash[Symbol, untyped] value) -> Hash[Symbol, untyped]
+  end
 end

data/assets/sig/capybara.rbs

@@ -0,0 +1,14 @@
+module Capybara
+  module DSL
+  end
+
+  module Minitest
+    module Assertions
+    end
+  end
+
+  module Poltergeist
+    class Driver
+    end
+  end
+end

data/assets/sig/concurrent.rbs

@@ -0,0 +1,4 @@
+module Concurrent
+  class Map
+  end
+end

data/assets/sig/erb.rbs

@@ -0,0 +1,4 @@
+class ERB
+  class Compiler
+  end
+end

data/assets/sig/erubi.rbs

@@ -0,0 +1,4 @@
+module Erubi
+  class Engine
+  end
+end

data/assets/sig/i18n.rbs

@@ -0,0 +1,4 @@
+module I18n
+  class Config
+  end
+end

data/assets/sig/minitest.rbs

@@ -1,2 +1,13 @@
-class Minitest::Test
+module Minitest
+  class Test
+  end
+
+  class SummaryReporter
+  end
+
+  class StatisticsReporter
+  end
+
+  module Assertions
+  end
 end

data/assets/sig/pg.rbs

@@ -0,0 +1,5 @@
+module PG
+  class Connection
+    def async_exec: (*untyped) -> untyped
+  end
+end

data/assets/sig/que.rbs

@@ -0,0 +1,4 @@
+module Que
+  class Job
+  end
+end

data/assets/sig/queue_classic.rbs

@@ -0,0 +1,4 @@
+class QC
+  class Queue
+  end
+end

data/assets/sig/racc.rbs

@@ -0,0 +1,4 @@
+module Racc
+  class Parser
+  end
+end

data/assets/sig/rack-test.rbs

@@ -0,0 +1,6 @@
+module Rack
+  module Test
+    class UploadedFile
+    end
+  end
+end

data/assets/sig/rack.rbs

@@ -0,0 +1,47 @@
+module Rack
+  class Server
+  end
+
+  class Response
+    module Helpers
+      def location: () -> untyped
+    end
+  end
+
+  class Request
+    module Helpers
+    end
+
+    module Env
+    end
+  end
+
+  module Session
+    module Abstract
+      class SessionHash
+      end
+
+      class PersistedSecure
+        class SecureSessionHash
+        end
+      end
+
+      class Persisted
+      end
+    end
+
+    class SessionId
+    end
+
+    class Dalli
+    end
+  end
+
+  module Cache
+    class MetaStore
+    end
+
+    class EntityStore
+    end
+  end
+end

data/assets/sig/rails.rbs

@@ -1,11 +1,10 @@
 module Rails
-  def self.root: () -> Pathname
-  def self.application: () -> Rails::Application
-end
-
-class Rails::Application
-  def routes: () -> untyped
-end
+  def self.env: () -> ActiveSupport::StringInquirer | ...
 
-class Rails::Railtie
+  module Dom
+    module Testing
+      module Assertions
+      end
+    end
+  end
 end

data/assets/sig/rdoc.rbs

@@ -0,0 +1,9 @@
+module RDoc
+  module Generator
+    class SDoc
+    end
+  end
+
+  class Task
+  end
+end

data/assets/sig/sidekiq.rbs

@@ -0,0 +1,4 @@
+module Sidekiq
+  module Worker
+  end
+end

data/assets/sig/sneakers.rbs

@@ -0,0 +1,4 @@
+module Sneakers
+  module Worker
+  end
+end

data/assets/sig/stdlib.rbs

@@ -1,14 +1,24 @@
-class Logger
+module DRb
 end
 
-class Logger::Formatter
+module DRb::DRbUndumped
 end
 
-module Mutex_m
+module TSort
 end
 
-module DRb
+class SimpleDelegator
 end
 
-module DRb::DRbUndumped
+module Gem
+  class Version
+  end
+end
+
+module OpenSSL
+  class Cipher
+  end
+end
+
+module FileUtils
 end

data/assets/sig/sucker_punch.rbs

@@ -0,0 +1,4 @@
+module SuckerPunch
+  module Job
+  end
+end

data/assets/sig/thor.rbs

@@ -0,0 +1,12 @@
+class Thor
+  class Group
+  end
+
+  module Actions
+    class CreateFile
+    end
+  end
+
+  class Error
+  end
+end

data/assets/sig/tzinfo.rbs

@@ -0,0 +1,4 @@
+module TZInfo
+  class Timezone
+  end
+end

data/bin/add-type-params.rb

@@ -1,15 +1,22 @@
+#!ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'rbs', '1.0.0'
+end
+
 require 'rbs'
-rbs = ARGF.read
-decls = RBS::Parser.parse_signature(rbs)
 
 def args(n)
   (:T..).take(n)
 end
 
 def env
-  @env ||= RBS::Environment.new.tap do |env|
+  @env ||= begin
     loader = RBS::EnvironmentLoader.new()
-    loader.load(env: env)
+    RBS::Environment.from_loader(loader).resolve_type_names
   end
 end
 
@@ -17,7 +24,7 @@ def apply_to_superclass(decl)
   return unless decl.super_class
 
   name = decl.super_class.name
-  type = env.find_class(name) || env.find_class(name.absolute!)
+  type = env.class_decls[name] || env.class_decls[name.absolute!]
   return unless type
   return if type.type_params.empty?
 
@@ -32,12 +39,21 @@ def apply_to_superclass(decl)
   decl.instance_variable_set(:@type_params, type_params)
 end
 
+def apply_to_itself(decl)
+  name = decl.name
+  type = env.class_decls[name] || env.class_decls[name.absolute!]
+  return unless type
+  return if type.type_params.empty?
+
+  decl.instance_variable_set(:@type_params, type.type_params.dup)
+end
+
 def apply_to_includes(decl)
   decl.members.each do |member|
     next unless member.is_a?(RBS::AST::Members::Mixin)
 
     name = member.name
-    type = env.find_class(name) || env.find_class(name.absolute!)
+    type = env.class_decls[name] || env.class_decls[name.absolute!]
     next unless type
     next if type.type_params.empty?
 
@@ -46,14 +62,24 @@ def apply_to_includes(decl)
   end
 end
 
-decls.each do |decl|
-  case decl
-  when RBS::AST::Declarations::Class
-    apply_to_superclass(decl)
-    apply_to_includes(decl)
-  when RBS::AST::Declarations::Module, RBS::AST::Declarations::Interface, RBS::AST::Declarations::Extension
-    apply_to_includes(decl)
+def analyze(decls)
+  decls.each do |decl|
+    case decl
+    when RBS::AST::Declarations::Class
+      apply_to_itself(decl)
+      apply_to_superclass(decl)
+      apply_to_includes(decl)
+      analyze(decl.members)
+    when RBS::AST::Declarations::Module, RBS::AST::Declarations::Interface
+      apply_to_itself(decl)
+      apply_to_includes(decl)
+      analyze(decl.members)
+    end
   end
 end
 
+rbs = ARGF.read
+decls = RBS::Parser.parse_signature(rbs)
+analyze(decls)
+
 puts RBS::Writer.new(out: $stdout).write(decls)