rbs_rails 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5dc0321730c8a515b7fb485221b43cc9424994fa6e6c351505fbca3c09ae4e1
-  data.tar.gz: a930ab4b1cac5c0f819ab2d8d1bc18be47bbca00dc41990e185513f7a2cff1a8
+  metadata.gz: 82919f7e04d613a702ad6cadbff8df905f23b54bf7dbdae04122a5af5df09608
+  data.tar.gz: 7070d476fe7f15776eed7fa406c423f18ba54077b4293ccb6064c151c7a89754
 SHA512:
-  metadata.gz: 5efd9e8eabe42a075f9dcf0d15c5e79d7cec935b8d812161cd20ed675b81691ab4d766bc3f59b8b196b3afb39961599d599082bb5d57166b34400f52c16aa716
-  data.tar.gz: ede7db12226ec86c8f4617c2fcf6713dfda220572bc0dcad7b6d58c3a372c716d20b15124bc245cb02968fb17ca2dbe97d160d137a026d85054ef6257f5eaa95
+  metadata.gz: 92c046d0f404ff63fe86b3fab5bd92dd24731919827c5ee04330cecf26ae158608e4b0babc1097977ef5cddcbd9474983621d188b996cf264cb96a65142adf95
+  data.tar.gz: 947c7022e0e49010cdc0fbce0bd453993f3ba0bc3df1fb5d406bce94361c49f8d61044b95ba9fed901e6635a9476b4c699812f2334e5e36552552138baada338

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7, '3.0']
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

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/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change log
+
+## master (unreleased)
+
+## 0.7.0 (2020-12-28)
+
+* **[BREAKING]** Re-structure signature directory. [#86](https://github.com/pocke/rbs_rails/pull/86)
+* Generate ActiveRecord models with namespaces and superclasses. [#87](https://github.com/pocke/rbs_rails/pull/87)

data/Gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem 'rbs', '>= 0.6.0'
-gem 'steep', '>= 0.19.0'
+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,56 +20,23 @@ Or install it yourself as:
 
 ## Usage
 
-### For Active Record models
-
-It has two tasks.
-
-* `copy_signature_files`: Copy type definition files for Rails from rbs_rails.
-* `generate_rbs_for_model`: Generate RBS files from model classes.
+Put the following code to `lib/tasks/rbs.rake`.
 
 ```ruby
-# Rakefile
-
-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?
-
-  Rails.application.eager_load!
+require 'rbs_rails/rake_task'
 
-  ActiveRecord::Base.descendants.each do |klass|
-    next if klass.abstract_class?
+RbsRails::RakeTask.new
+```
 
-    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-    FileUtils.mkdir_p(path.dirname)
+Then, the following four tasks are available.
 
-    sig = RbsRails::ActiveRecord.class_to_rbs(klass)
-    path.write sig
-  end
-end
-```
+* `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
 
-### For path helpers
 
-```ruby
-# Rakefile
 
-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
-end
-```
 
 ### Steep integration
 
@@ -83,12 +50,25 @@ target :app do
 
   check 'app'
 
+  repo_path "path/to/rbs_repo"
+
   library 'pathname'
   library 'logger'
   library 'mutex_m'
+  library 'date'
+
+  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,5 +1,7 @@
 require "bundler/gem_tasks"
-task :default => [:rbs_validate, :steep]
+require 'rake/testtask'
+
+task :default => [:rbs_validate, :steep, :test]
 
 desc 'run Steep'
 task :steep do
@@ -7,5 +9,12 @@ task :steep do
 end
 
 task :rbs_validate do
-  sh 'bin/rbs validate'
+  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,9 +3,18 @@ target :lib do
   signature 'assets/sig'
 
   check "lib"                       # Directory name
+  repo_path ENV['RBS_REPO_DIR'] || './gem_rbs/gems'
 
   library "pathname"
   library "logger"
   library "mutex_m"
-  # library "strong_json"           # Gems
+  library "date"
+
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
 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/rack.rbs

@@ -4,6 +4,7 @@ module Rack
 
   class Response
     module Helpers
+      def location: () -> untyped
     end
   end
 

data/assets/sig/rails.rbs

@@ -1,5 +1,5 @@
 module Rails
-  overload def self.env: () -> ActiveSupport::StringInquirer
+  def self.env: () -> ActiveSupport::StringInquirer | ...
 
   module Dom
     module Testing
@@ -8,7 +8,3 @@ module Rails
     end
   end
 end
-
-class Rails::Application
-  def routes: () -> untyped
-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/sucker_punch.rbs

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

data/bin/add-type-params.rb

@@ -1,5 +1,12 @@
 #!ruby
 
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'rbs', '1.0.0'
+end
+
 require 'rbs'
 
 def args(n)

data/bin/gem_rbs

@@ -0,0 +1,94 @@
+#!ruby
+
+require 'net/http'
+require 'json'
+require 'securerandom'
+require 'pathname'
+
+TOKEN = ENV.fetch('GITHUB_ACCESS_TOKEN')
+VERSION = "6.0.3.2"
+
+def req(query)
+  http = Net::HTTP.new("api.github.com", 443)
+  http.use_ssl = true
+  header = {
+    "Authorization" => "Bearer #{TOKEN}",
+    'Content-Type' => 'application/json',
+    'User-Agent' => 'gem_rbs client',
+  }
+  resp = http.request_post('/graphql', JSON.generate(query), header)
+  JSON.parse(resp.body, symbolize_names: true).tap do |content|
+    raise content[:errors].inspect if content[:errors]
+  end
+end
+
+class QueryBuilder
+  attr_reader :variables
+
+  def initialize
+    @queries = []
+    @variables = {}
+  end
+
+  def add(query, variables)
+    query = query.dup
+    variables = variables.transform_keys do |key|
+      next key unless @variables.key?(key)
+
+      new_key = key + '_' + SecureRandom.hex(8)
+      query.gsub!(key, new_key)
+      new_key
+    end
+
+    @queries << query
+    @variables.merge!(variables)
+  end
+
+  def query
+    # TODO: variable type
+    "query(#{variables.keys.map { |v| "$#{v}: String!" }.join(',')}) { #{@queries.join("\n")} }"
+  end
+end
+
+gems = %w[activesupport actionpack activejob activemodel actionview activerecord railties]
+
+builder = QueryBuilder.new
+gems.each do |gem|
+  path = "main:gems/#{gem}/#{VERSION}"
+  builder.add(<<~GRAPHQL, { 'path' => path })
+    #{gem}:repository(owner: "ruby", name: "gem_rbs") {
+      object(expression: $path) {
+        ... on Tree {
+          entries {
+            name
+            object {
+              ... on Blob {
+                isTruncated
+                text
+              }
+            }
+          }
+        }
+      }
+    }
+  GRAPHQL
+end
+
+resp = req(query: builder.query, variables: builder.variables)
+
+resp[:data].each do |gem_name, gem_value|
+  gem_value.dig(:object, :entries).each do |entry|
+    fname = entry[:name]
+    if fname.end_with?('.rbs')
+      content =
+        if entry.dig(:object, :isTruncated)
+          `curl -H 'Accept: application/vnd.github.v3.raw' -H Authorization: token #{TOKEN} https://api.github.com/repos/ruby/gem_rbs/contents/gems/#{gem_name}/#{VERSION}/#{fname}`
+        else
+          entry.dig(:object, :text)
+        end
+      dir = Pathname("gem_rbs/gems/#{gem_name}/#{VERSION}")
+      dir.mkpath
+      dir.join(fname).write(content)
+    end
+  end
+end

data/bin/postprocess.rb

@@ -2,21 +2,26 @@
 
 # TODO: Expose me to user
 
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'rbs', '1.0.0'
+end
+
 require 'rbs'
 require 'rbs/cli'
 require 'optparse'
 
 def env(options:)
-  loader = RBS::EnvironmentLoader.new()
-  options.setup(loader)
+  loader = options.loader
   RBS::Environment.from_loader(loader).resolve_type_names
 end
 
 def parse_option(argv)
   opt = OptionParser.new
   options = RBS::CLI::LibraryOptions.new
-  cli = RBS::CLI.new(stdout: nil, stderr: nil)
-  cli.library_parse(opt, options: options)
+  options.setup_library_options(opt)
 
   return opt.parse(argv), options
 end
@@ -79,8 +84,10 @@ def may_eql_member?(a, b)
   a.name.to_s.split('::').last == b.name.to_s.split('::').last
 end
 
-def update!(update_targets:)
+def update!(update_targets:, only:)
   update_targets.group_by { |decl, _concern| decl.location.name }.each do |fname, target_decls|
+    next unless only.match?(fname)
+
     tree = RBS::Parser.parse_signature(File.read(fname))
     target_decls.each do |target_decl, concern|
       catch(:break) do
@@ -109,6 +116,8 @@ def run(argv)
   builder = RBS::DefinitionBuilder.new(env: env)
   matcher = FileMatcher.new(targets: targets)
 
+  only = ENV['ONLY']&.then { Regexp.new(_1) } || //
+
   update_targets = []
 
   env.class_decls.each do |_name, entry|
@@ -122,7 +131,7 @@ def run(argv)
     end
   end
 
-  update!(update_targets: update_targets)
+  update!(update_targets: update_targets, only: only)
 end
 
 run(ARGV)

data/bin/rbs

@@ -1,3 +1,30 @@
-#!/bin/bash
+#!ruby
+
+require 'pathname'
+root = Pathname(__dir__) / '../'
+
+def v(require)
+  if v = ENV['RAILS_VERSION']
+    "#{require}:#{v}"
+  else
+    require
+  end
+end
+
+def repo
+  ENV['RBS_REPO_DIR'] || Pathname(__dir__).join('../gem_rbs/gems').to_s
+end
+
+exec(
+  'rbs',
+  # Require stdlibs
+  '-rlogger', '-rpathname', '-rmutex_m', '-rdate',
+  "--repo=#{repo}",
+  # Require Rails libraries
+  v('-ractivesupport'), v('-ractionpack'), v('-ractivejob'), v('-ractivemodel'), v('-ractionview'), v('-ractiverecord'), v('-rrailties'),
+  # Load signatures that are bundled in rbs_rails
+  '-I' + root.join('sig').to_s, '-I' + root.join('assets/sig').to_s,
+  # Expand arguments
+  *ARGV,
+)
 
-rbs -rlogger -rpathname -rmutex_m -Isig -Iassets/sig $@